<< Click to Display Table of Contents >> Navigation:  Reference > Gateway properties >
Clickatell gateway

Clickatell properties (Platform)

---

REST API key

The REST API key of your Clickatell Platform REST integration.

 

Clickatell properties (Communicator / Central)

---

API id

The HTTP API ID of your Clickatell http account.

 

Username

The user name of your Clickatell account.

 

Password

The password of your Clickatell account.

 

 

 

Advanced properties

---

ApprovedFromList

Clickatell supports both numeric and text sender id's. To prevent spoofing, Clickatell requires that sender id's have to be approved by them before you can use them. To use an originator you have to list them here, one originator per line.  All originator addresses that are not in this list are filtered out by the Clickatell gateway.

 

DefaultFrom

If no originator is supplied or the originator is not in the ApprovedFromList this default originator will be used.

 

HttpHost (Communicator / Central only)

The Clickatell host name. Both secure and unsecured connections are supported.

https://api.clickatell.com                secure Clickatell host.

http://api.clickatell.com                unsecured Clickatell host.

 

HttpParameters (Communicator / Central only)

Optional extra parameters that are used when sending an SMS message to Clickatell. An example is the parameter MO=1, an indication that the message is Mobile Originated and that the receiver can send a response back.

 

LogCommunicationToFile

Log all internet communication to file. Use this option only if you encounter problems with the connection to your Clickatell account. If enabled, the status windows of the Clickatell gateway provides a link to the location on you hard disk where the file is stored.

 

MaximumBatchSize

The maximum number of messages this gateway will process in one batch. If this value is higher than one and a number of messages are sent at the same time, the gateway loads multiple messages concurrently. This increases the speed in which the messages are sent.

 

NumberTemplate

The number template can be used to translate the number from one format to another.

 

For more information see Use number templates.

 

QuietHours

A list of 24 hour numbers (separated with semicolons) when sending messages with this gateway is paused. The hour number can be appended with .1, .2, .3 or .4 to specify the first, second, third or fourth quarter of the hour. If the messages cannot be sent with another gateway, they stay in the send queue until the quiet hours are over and this gateway resumes message sending.

00;01;23 pauses message sending from 23:00:00 to 01:59:59.

12.1;12.2;18.1;18.2 pauses message sending from 12:00:00 to 12:29:59 and from 18:00:00 to 18:29:59.

 

MaxMessageParts

Messages to send that are longer than 160 characters or 70 characters for Unicode messages can be split in multiple SMS messages that are recombined to one message on the handset of the receiver. The MaxMessagePart property limits the amount of partial messages that the gateway sends with a long message. If the message is longer than can be sent with the maximum message parts, the rest of the message is discarded.

 

MessageType

The message type is the default value for the SMS message encoding, the default value may be replaced with the message type specified by the sending Connector.

The gateway uses four possible value for the default message type:

 

 

The Clickatell gateway supports the following custom message types: