Configuring SMS Interface

Use

With this view, you define the interface that enables sending SMS messages. Nowadays the only option is HTTP. Other options are local, customer specific, or outdated, and available to support customers with older versions of the software, only.

Prerequisites

HTTP: You must have a service provider for the HTTP push service.

Procedure

  1. Double-click the SMS Server module in the Modules table.

  2. Choose the Session Object type.

  3. For the default type, HTTP, enter the required parameters. For other options, define the interface with the Session String and Connection String fields.

HTTP

Note:

With HTTP, you do not need to enter the Connection String value. The field is available for the users that have that string readily from earlier versions.

At startup the SMS module prints to a log an INFO level message that contains an example HTTP query that can be used to fine-tune the parameters.

Table 1. HTTP Interface Parameters

Parameter

Description

Set Password

If the service provider requires a secure connection, select this option, and enter the password.

Note:

  • If this password is used, it must be encrypted. For that, the Certificate for External Password Encryption must be defined in Agent Server variables in IA, and the certificate must be installed on servers where Agent Server, CEM Server, Email Sender, and SMS Server are installed.

  • The encryption certificate (Agent Server variable Certificate for External Password Encryption) is used also for decryption even if that certificate has expired. If the expired certificate is removed from the system, encryption/decryption will fail. To avoid that, do not remove the expired certificate from the servers where Agent Server, CEM Server, Email Sender, and SMS Server are installed. If the certificate has been removed, to correct the situation re-enter this password, and the one in System Services > E-Mail Settings.

Set Local Password

To use a secure connection for receiving SMS messages, select this option and enter the password. This password is used for the SMS cloud to authenticate itself to the Sinch Contact Pro SMS service.

HTTP Keys

For entering specific information required by the service provider. Enter that in name=value pairs that configure how the HTTP query is built, for example: Okey=src;Dkey=dest;Bkey=body;werb=GET.

  • Okey: A string, defines name for a parameter containing sender’s address (number)

  • Dkey: A string, defines name for a parameter containing destination address.

  • Bkey: A string, defines name for parameter containing message body.

  • werb: A string, defines the http query werb. Possible values are POST and GET.

  • OKstr: A string, defines optional string. If the string is found on HTTP servers, the reply message indicates success, for example: 200 OK. If the OKstr string is not defined, only HTTP status is used to determine if the sending was successful. The default value is empty (not in use).

  • SearchBody: 1/0. Specifies if also reply message body is searched for OKstring. The default value is 0 (not in use).

  • URLEnc: 1/0. Specifies if a message sent to the SMS server provider is URL-encoded. The default value is 0 (not in use).

  • URLEncGet: 1/0. The value 1 specifies that only message text of the GET request is URL-encoded.

Additional Data

Define additional information that SMS service providers may require, for example the character set used. String is passed as such, and its form and content depend on the service provider. For example: &data_type==UTF8&flags=1, &data_type==data_latin1

HTTP Server Address

IP address of the SMS service provider’s server.

HTTP Page

Web page that provides the SMS functionality.

If you use Twilio, the path must contain the user name, that is, the value of User that you have given in the Session String parameter.

HTTP Port

Port number of the SMS service providers server where the SMS engine connects to.

AT

This feature is deprecated.

The AT option enables using a modem that communicates using the AT language. With this option, you must have a modem installed in your system. Define interface with Session String and Connection String fields.

Table 2. AT Modem Interface Parameters

Definition

Mandatory

Description

Session String

Mandatory

Enter a string that contains the following (mandatory) parameter=value pairs separated with semicolon. For example: PIN=1234;Logfiles=c:\temp\;ReceptionWaitSubsequentBytesMS=20000;SleepAfterSendMS =2000;WaitAfterNumberPutMS=6000;

PIN

Mandatory

Define four-numbered PIN code.

ReceptionWaitSubsequentBytesMS

Optional

The default value is 20000 (20 seconds)

SleepAfterSendMS

Optional

The default value is 2000.

WaitAfterNumberPutMS

Optional

The default value is 5000.

Logfiles

Optional

Define the path where log files are saved.

Connection String

Mandatory

Enter a space between ComParams, baud, parity, data, and stop. Enter a semi-colon (;) before WaitFirstByteMS and WaitSubsequentBytesMS. For example: ComParams=COM1 baud=19200 parity=N data=8 stop=1;WaitFirstByteMS=30000;WaitSubsequentBytesMS=3000

ComParams

Mandatory

COM1

WaitFirstByteMS

Optional

The default value is 20000

WaitSubsequentBytesMS

Optional

The default value is 3000.

Content Gateway

This option enables using Content Gateway. The option is meant for specified customers only.

File

File option saves the SMS messages in file(s), and a customized service sends them further on. The option is meant for specified customers only.

CIMD2

CIMD2 option is used in systems that can use Computer Interface to Message Distribution (CIMD) version 2.0 service protocol. Define interface with Session String and Connection String fields.

Table 3. CIMD 2 Interface Parameters

Definition

Mandatory

Description

Session String

Mandatory

Enter a string that contains the following (mandatory) parameters=value pairs separated with semicolon. For example: Username=uname;Password=qwerty;ip=1.2.3.4;port=9971;

Username

Mandatory

Define the username for the connection.

Password

Mandatory

Define the password for the connection.

ip

Optional

For advanced use only

port

Optional

For advanced use only

Logfiles

Optional

Define the path where log files are saved.

Connection String

Mandatory

Enter a string that contains the following (mandatory) parameters=value pairs separated with semicolon. For example: Destination=1.2.3.4;Port=9971;.

Destination

Mandatory

Define the IP address of the service provider’s server.

Port

Mandatory

Port number of the SMS service providers server where the SMS engine connects to.