SMTP API Features
A variety of messaging and SMS features are supported by the gateway, which can be activated by including additional parameters. These parameters include the ones as stated in the table below.
Feature |
Description |
Values |
Default |
Parameter |
---|---|---|---|---|
Client Message ID |
Client message ID defined by user for message tracking. |
Up to 32 alphanumeric characters, no spaces allowed. |
none |
cliMsgId |
Concatenation |
Specifies the maximum number of message parts available for the message. |
1,2,3 |
Defaults to setting on your API connection |
concat |
CSV Line |
Used in conjunction with text parameter to handle personalized template messaging. |
The mobile number must be the first value in the CSV field. |
none |
csv |
CSV Template |
Used in conjunction with text parameter to handle personalized template messaging, where additional message parameters need to be set on a message basis. |
API parameters, example: deliv_time, cliMsgId |
none |
csvtemplate |
Delimiter Character |
The character you would like to use as a delimiter with csv. If you use the default delimiter (a comma), you cannot use a comma in your field values. |
Any single character that does not exist in your message or fields. A pipe character ‘|’ is usually a useful value. |
, |
delimiter |
Delivery Time |
Delays delivery of your SMS to the mobile device in minutes relative to the time at which the SMS was received by our gateway. |
Any numeric value. The upper limit is seven days or 10080 minutes. |
0 |
deliv_time |
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 |
queue |
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”. It works within the bounds of the profiles, i.e. a profile must exist for the maximum credit you set. |
0.8,1,1.5,2,2.5,3 |
none |
max_credits |
Message Text |
The content of your SMS message. |
Hello World |
text |
|
Message Type |
Send other types of messages such as flash messages. |
Refer to Message Type page. |
msg_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. |
0,1 |
0 |
mo |
Reply |
One or more email addresses that will be sent an API response email. |
none |
reply |
|
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 |
req_feat |
Scheduled Time |
Specify when a message should get delivered in GMT+0. |
2015-06-30T14:00:00Z |
none |
scheduled_time |
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 |
URL Encoded Text |
This is a URL encoded form of text. This is meant to be used if you want to send characters like Greek characters or newline characters. |
Your%20URL%20encoded%20text%21 |
none |
urltext |
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 |
validity |
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 |
bypass_dnc_check |
Submit a Comment
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