SMS

To implement Short Messaging Service (SMS) in your organization, install the following components:

• SMS Dispatcher Service – This is a Windows service that dispatches SMS messages to the web server of the service provider. The service provider dispatches these messages to recipients.

• SMS Extractor Service – This is a Windows service that must be installed. SMS messages are pushed to this Windows service from the web server to which they were pushed by the service provider, or extracted from the service provider. The service processes SMS content received in a specific format from the service provider. This processed information (SMS message or SMS Status) is then transferred to the Main database.

• SMS Web Service – This is the IIS virtual root to which the service provider pushes SMS messages or delivery statuses (e.g., SMS-Magic) specific to your organization. Alternatively, this web service can be configured to pull SMS messages from the service provider.

Prerequisites

Identify and install the prerequisite software. See Software Requirements by Component — SMS.

Install the SMS dispatcher and extractor services as follows:

1. To install the SMS Dispatcher Service, obtain the following information from the respective service provider:

   • Credentials of your account with service provider like user name, password, APP ID or Label. These details can change from provider to provider.

   • If your organization is integrating SMS with Clickatell, in addition to the above information, create an API ID using the XML POST method from Clickatell.

     To do so:

     1. Log on to the Clickatell website using the Clickatell user name and password details.

     2. Click the Manage my Products tab.

     3. In the Connection Setup page, click XML. The Add Connection, XML API page is displayed.

     4. In the Description field, specify a description for the XML API, and click the Submit and Get API ID button. An XML API is created.

   • Public URL – The URL from the service provider to which the SMS Dispatcher Service will send the SMS message.

     Example of Public URL for:

     • Clickatell: https://api.clickatell.com/xml/xml
     • SMS-Magic: https://api.sms-magic.co

2. To install the SMS Extractor Service, obtain the following details:

   When the service provider is ValueFirst:

   • URL of the service provider

   • User name and password details of your account

   If you are integrating with any service provider, including ValueFirst:

   • Short Code or Long Code – A code provided by the service provider that customers will use to respond to SMS messages.

   Occasionally, the same Short Code is shared among multiple organizations. This is referred to as a Shared Short Code. If an organization requests a Shared Short Code, the service provider provides a Keyword to the organization which helps the service provider to dispatch the SMS messages received from the customers to the correct organization based on the Keyword specified in the SMS message.

   • Keyword – A text, numeric, or a combination of text and numeric characters that an organization requests a recipient of an SMS message to type in the response SMS message. The organization performs specific actions based on the Keyword typed by the recipients in the response SMS message. This is optional based on the service provider and account of the customer. It is required only with the short code.

 

Set Up SMS

1. In the Installation menu, click SMS. The SMS Settings screen is displayed.  

   

2. Click Add to add a line to the Settings screen.

3. Select an appropriate Action. The following Action values are available:

   • None – Performs no action.

   • Install – Performs a fresh installation or upgrade of a component. You can install or upgrade multiple components at the same time.

   • Uninstall – Removes all subcomponents on that machine and uninstalls the component from Programs and Features.

   • Reinstall – Retries to install a subcomponent.

   • Add – Installs an additional component on the computer where one or more components already exist. You can add only one component at a time.

   • Remove – Uninstalls a single component. You can remove only one component at a time.

   Optional: Click Select All to set the Action field to Install for all components listed on this screen. Click Unselect All to set the Action field to None.

4. Enter the Machine Name for the component to be installed.

5. Select a Database from the Database list.

6. Select an SMS Component. The options are:

   • Dispatcher
   • Extractor
   • WebService

   Note: If you are installing all SMS components, make sure Extractor Service is installed before WebService.

7. Select Dispatcher from the SMS Component list.

8. Click to view and edit the Options form.

   

9. In the Dispatcher Options form, complete the following fields as applicable:

   • SMS Dispatcher Service
   • Service Provider
   • Other Provider Name — displayed only when OTHER is selected.
   • Service Provider URL
   • Login Name — disabled for TELESIGN
   • Password — disabled for TELESIGN
   • Customer ID — enabled only when TELESIGN is selected.
   • API Key
   • Label

10. Click OK to save changes on the Options form. The form is closed.

11. Click to copy a line. Edit the copied line as needed.

12. Select Extractor from the SMS Component list.

13. Click to view and edit the Options form.

    

14. In the Extractor Options form, complete the following fields as applicable:

    • Service Provider

    • Other Provider Name – This field is displayed only when the Service Provider OTHER is selected.

    • SMS Extractor Service Name

    • Port Number

    Notes:

    • Do not specify the value 80 or other known port numbers in the Port Number field.

    • Ensure that the TCP port specified in the Port Number field is open between servers where the SMS virtual root and SMS Extractor Service are installed.

15. Click OK to save changes on the Options form. The form is closed.

16. Click to copy a line. Edit the copied line as needed.

17. Select WebService from the SMS Component list.

18. Click to view and edit the Options form.

    

19. In the Web Service Options form, complete the following fields as applicable:

    • SMS Code — Depending on the Service Provider, the SMS Code field allows the following input values:

      Service Provider	SMS Code
      CLICKATELL	Numeric
      OTHER	Any character
      SMSMAGIC	Alphanumeric
      TELESIGN	Numeric
      VALUEFIRST	Numeric

    • Web Service Name

    • Service Provider

    • Other Provider Name — This field is displayed only when the Service Provider "Other" is selected.

    • Service Provider Keyword — This is optional based on the service provider. Specify this if your provider has given this information.

    • Extractor Service Name

    The supported method to receive SMS Messages is Push for all services providers except VALUEFIRST, which uses the Pull method.

    If you select the Pull method, specify the following:

    • Service Provider URL

    • Login Name

    • Password

20. Click OK to save changes on the Options form. The form is closed.

21. Click to delete a selected line.

22. Accept the default Destination Directory or select a directory where the information for this component is stored. Changing this directory will apply across all machines in the Machine Name column.

23. Specify the Log File Path or accept the default: C:\Program Files\Talisma SMS\Setup Logs

    The Log File Path applies to all the machine names configured in the SMS Settings screen.

24. Click Test to ensure the setup for the corresponding line is correct. If a test on a particular line fails, check all associated fields and click Test again.

25. If all tests pass, click .

Note: In a scenario where multiple long codes are available in your organization, to ensure that the auto response to the contact is sent from the correct dispatcher, the AutoResponseDispatcherID parameter must be updated in the TLSysSMSWindowService.exe.config file of the associated extractor. This file is available in the path where the SMS Extractor is installed.

1. Navigate to the path were the extractor is installed.

2. Open the TLSysSMSWindowService.exe.config file using a text editor (e.g., Notepad) and update the value in the following code:

   <add key="AutoResponseDispatcherId" value="" />

3. In the value field, type the dispatcher’s ID that is associated with the long code. The ID is available in the tblSMSServices table of Main database in the aSMSServiceID column.

4. Save the file and then restart the SMS Extractor service.

 

Configuration