SMS

You can configure the SMS Gateway servers for your application. Use these configured servers to send outbound SMS messages. After setting up the SMS server, you can perform the following:

1. Receive SMS messages from your customers and allow a Campaign Manager application or agent to respond to them.

2. Send SMS messages in your outbound campaigns.

Add New SMS Server

To add a new SMS server:

1. Click Create SMS Server to start the setup of a new SMS server.

2. Enter the SMS Server Name to uniquely identify the server and provide a Description to specify its purpose or functionality within the system.

3. Select the Server Type from Gateway URL, SMPP, or CPaaS based on the protocol system used to send and receive SMS messages.

4. Click Next to proceed with the configuration.

Server Credentials

1. Go to the Server Credentials tab. This tab displays fields based on the selected server type.

2. If the Server Type is Gateway URL:

   1. Enter the Gateway URL to specify the server endpoint.

   2. Enter the User Name for authentication.

   3. Enter the Password to securely access the Gateway URL.

3. If the Server Type is SMPP:

   1. Enter the SMPP Server Name to establish a connection.

   2. Enter the SMPP Port Number to connect to the SMPP server.

   3. Enter the SMPP User Name to access the SMPP server.

   4. Enter the SMPP Password to authenticate and securely access the SMPP server.

   5. Select the SMS Mode from the following options:

      1. Sender and Receiver

      2. Sender

      3. Receiver. If the SMS Mode is set to Receiver, enter the Number of Receiver Instances to define the number of connections for receiving messages.

      Note

      Supported SMS service providers using the SMPP protocol include ACL, WebText, AT&T, and ImiMobile.

4. If the Server Type is CPaaS:

   1. Select a Provider from the following options:

      1. Twilio

      2. Amazon Pinpoint

      Note

      If the Server Type is CPaaS and the selected provider is Nexmo or Others, the application does not allow editing these provider options. Nexmo and Others are no longer supported from this release

5. Enter the appropriate values in the required fields based on the selected provider.

6. Click Next.

Server Configuration

1. Go to the Server Configuration tab.

2. Select the Delivery Status Type to Required if you need delivery status updates for your SMS messages.

3. Select the Delivery Type from Webhook or Polling methods.

4. If Delivery Type is Webhook, enter the Delivery Status URL which provides the delivery status of the SMS you have sent. For example: https://<fqdn/hostname<or>PublicIPAddress>/HttpSmsReceiverApi/api/DeliveryStatus

5. If Delivery Type is Polling Method, configure the following parameters:

   1. Define the Number of Message IDs per Request. It is the number of message IDs the system must request in each polling attempt.

   2. Specify the Minimum Polling Range. Enter the minimum time (in minutes) after SMS delivery for the system to start checking the delivery status. For example, if an SMS is delivered at 1:00 PM and the minimum range is set to 5 minutes, the system starts checking at 1:05 PM.

   3. Specify the Maximum Polling Range. Enter the maximum time (in minutes) after SMS delivery during which the system will continue to check the delivery status. For example: If the maximum range is set to 60 minutes, the system checks for delivery status until 2:00 PM.

6. Provide the Prefix to be used for sending SMS messages.

7. Click Save to apply the configurations.

Update SMS Server

1. Select the server name and click Edit.

2. Update the server details and click Save.

3. To Delete, select the server and click Delete. Click Ok on the confirmation pop up.

CPaaS Configuration

Configure Twilio Flex

Sending campaign SMS messages using Twilio Flex service provider usually takes 2 to 4 seconds. To eliminate this delay, the application is enhanced to send the messages in an Asynchronous mode. To achieve this, we have added a new configuration AsyncTwilioSupport to the HttpSMSReceiverAPI component. This must be set to true to send the SMS messages asynchronously.

To configure a new CPaaS provide as Twilio Flex:

1. Select the type of Authentication from Account SID or API Key.

2. If the selected Authentication Type is Account SID:

   1. Enter the Auth Token to authenticate the Account SID.

   2. Enter the SMS Receiver API URL which serves as the endpoint for receiving SMS messages.

3. If the selected authentication type is API Key:

   1. Enter the Account SID which is the account string ID provided for the application.

   2. Enter the API Key provided by Twilio Flex for the user.

   3. Enter the API Secret key provided by Twilio Flex. The API Key and API Secret combined together complete the authentication.

4. Enter the SMS Receiver API URL, the endpoint for the SMS Receiver API to receive SMS messages. For example: https://<fqdn/hostname<or>localIPAddress>/HttpSmsReceiverApi/api

5. Click Next.

   Note

   This configured URL is populated in the IVR Template Editor for your IVR campaigns.

Configure Amazon Pinpoint

You must first configure Amazon Pinpoint. Refer to Amazon Documents for detailed instructions on how to set up and use this application for SMS campaigns.

1. Select Amazon Pinpoint as the Service Provider from the dropdown list.

2. Activate the Role-based Authentication if the application server is hosted on AWS-EC2 and this AWS-EC2 has direct access to the Pinpoint project. Deactivate the Role-based Authentication if an AWS-IAM account is being used to access the Pinpoint project and If the server is not hosted on AWS-EC2.

3. Enter the AWS App ID, a unique identifier for your Amazon Pinpoint application.

4. Enter the AWS Access Key and AWS Secret Key for the IAM account to authenticate and access the Pinpoint project.

   Note

   These are not required if you are using Role-based Authentication.

5. Enter the AWS Region where your Amazon Pinpoint project is hosted.

6. Provide the SMS API URL for the HttpSmsReceiverApi Web API application to activate communication with the Pinpoint service.

Configure Five9 VCC

To configure a new CPaas Provide as Five9 VCC:

1. Select Five9 VCC as the service provider from the dropdown list.

2. Set the value for Batch Size. This is the number of phone numbers included in a single API request. This setting enables efficient batch processing of phone number data.

3. Enter the Five9 API URL. This is the base URL of the Five9 VCC API servers for establishing a connection.

4. Enter the Domain Id to access and manage the domain with Five9 VCC.

5. Enter the Client ID and Client Secret Key that are required to get an access token from the Five9 VCC cloudauthsvcs endpoint. This combination ensures secure authentication with the API.

6. Enter the SMS Receiver API URL for the SMS Receiver API. For example - https://<fqdn/hostname<or>localIPAddress>/HttpSmsReceiverApi/api

Fields