Overview of the REST API features
Archived
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:
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