Overview of the REST API features
A variety of messaging and SMS features are supported by the gateway and can be activated by including additional parameters. These parameters include the ones stated in the table below:
Feature |
Description |
Values |
Default |
Parameter |
---|---|---|---|---|
Binary |
Force the message content to be sent as binary (8-bit) data. |
0,1 |
0 |
binary |
Client Message ID |
Client message ID defined by user for message tracking. |
2993b6b548 |
none |
clientMessageId |
Concatenation |
Specifies the maximum number of message parts available for the message. |
1,2,3 |
Defaults to setting on your API connection. |
maxMessageParts |
Delivery Queue |
Delivers the message through one of three queues assigned to each client account. Messages in the highest priority queue will be delivered first. |
1,2,3 |
3 |
userPriorityQueue |
Destination Address |
The mobile number of the handset to which the message must be delivered (MSISDN). The number must be in international format with no leading zeros or + symbol. |
27831234567 (South Africa) 16501234567 (USA) 44123456789 (UK) |
none |
to |
Enable Callback |
Enables you to receive message delivery status updates via an HTTP request made to your server. |
0,1,2,3,4,5,6,7 |
0 |
callback |
Gateway Escalation |
Prompts an escalation to an alternative (more expensive) route, if messages are queued or delayed on the least-cost route. |
0,1 |
0 |
escalate |
Maximum Credits |
Overrides the maximum charge specified online in “routing profiles”. |
0.8,1,1.5,2,2.5,3 |
none |
maxCredits |
Message Text |
The content of your SMS message. |
Hello World |
text |
|
Message Type |
Send other types of messages such as flash messages. |
Refer to description |
type |
|
Mobile Originated |
This is only applicable to clients that have subscribed to a two-way messaging service. We route via pre-defined carriers to enable the ability for a reply to be received back. |
0,1 |
0 |
mo |
Required Features |
Some parameters and features are not set as “required” by default and may be dropped if the least-cost route does not support them. Set this parameter to ensure that the features set when an SMS is sent are supported by the gateway used. |
Refer to description |
none |
requiredFeatures |
Scheduled Time |
Specify when a message should get delivered in GMT+0. |
2015-06-30T14:00:00Z |
none |
scheduledDeliveryTime |
Sender ID |
The source/sender address that the message will appear to come from (also known as the “Sender ID”). These must be registered within your online account and approved by us before they may be used. Two-way numbers rented from us do not require approval. |
none |
from |
|
Unicode Message |
Two-digit language code. Convert your text to Unicode [UCS-2 encoding]. See http://www.Unicode.org/. |
0,1 |
0 |
unicode |
User Data Header |
Set the UDH content of a message. |
udh |
||
Validity Period |
The validity period in minutes relative to the time at which the SMS was received by our gateway. The message will not be delivered if it is still queued on our gateway after this time period. |
25 |
24 Hours |
validityPeriod |
Bypass DNC Check |
Feature to bypass the DNC lookup. Default behavior is to do a lookup unless overridden by this parameter. A value of “0” will still force a lookup; a value of “1” will force a lookup bypass. |
0,1 |
none |
bypassDNCCheck |
Channels
Find the most up-to-date information about the channels available to communicate with your clients.

SMS
Enable any application, website or system to facilitate local or international one- or two-way SMS communication via an easy one-step integration with our HTTP API.
Documentation

One API
Communicate with your mobile customers via multiple communication channels with a single integration. You can send and receive messages on both WhatsApp and SMS without the overhead of programming individual channels.
Documentation

As an authorized WhatsApp Business Solution Provider, we assist you in applying for a WhatsApp Business account and number. Integrate with other powerful features available on our platform via our One API.
Documentation
Products
Find the most up-to-date information about the products we offer and how to elevate your engagement with customers.

Chat 2 Pay
Send payment requests to customers via chat for secure, contactless payment experiences.
Documentation

Chat Desk
An easy-to-use web-based application that enables real-time communication with your customers via a single web interface.
Documentation

Chat Flow
A web-based application that allows you to quickly and collaboratively design and deploy conversational experiences across multiple chat applications and connect it to your organization's core functional APIs.
Documentation

Campaign Manager
An online tool that allows you to create a custom SMS campaign within minutes - no coding or developers required.
Documentation
Marketplace
Find the most up-to-date information about Clickatell's Marketplace and how you can utilize it for the distribution and payment acceptance of digital products.
Bank Interfaces API
An explanation of the way Clickatell and banks interact with one another when dealing with purchases.
Documentation
Transact Result API
Initiates the delivery of the transaction result for a purchase that was made through Clickatell after Clickatell facilitated the dispensing of the product.
Documentation
Reserve and Transact API
Initiates a purchase and fund reservation request to Clickatell.
Documentation
Security Service API
Request authentication tokens to use in all other Clickatell API calls.
Documentation
Transact
A cloud-based platform that allows for the distribution and payment acceptance of multiple digital products.
Documentation
In-Flight Transaction Check API
Used prior to a purchase instruction to confirm that no similar transaction is in progress.
Documentation
User Transaction Lookup API
Identify if a new transaction is similar to one of the user's recent transactions so the response details can be used to pre-emptively complete the current transaction details.
Documentation
Customer Account Validation API
Validate a customer's bill payment account number prior to submitting the bill payment purchase request to the vendor.
Documentation
MNO Lookup API
Derive the specific mobile network operator (MNO) for the specified MSISDN.
Documentation
Token Lookup API
Look up tokens/vouchers to present back to the buyer/customer who purchased token-related products via Clickatell's platform.
Documentation
Notifications API
Send notifications to buyer/recipient using different channels.
Documentation
Transaction Lookup API
Used after a purchase to confirm the transaction status.
Documentation
Financial Terms Lookup API
Display the correct fee and settlement amounts as per the contractual agreement for the SKU being purchased.
Documentation
Other Resources
Ask the Community
Visit Stack Overflow to join our community of developers and find the answer you need
Contact Support
Contact our support team and one of our agents will be in touch with you to answer any questions you have