The API supports the transmission of SMS messages via HTTP POST

Parameters:

URL: (provided by provisioning team)

app_id: Assigned application ID (alphanumerical, e.g. A19293).

key: Assigned authentication parameter (alphanumerical, e.g. 5c12b9d099).

dest_addr: Telephone number to which messages are sent to including country prefix (e.g. 16175551212).

source_addr: Transport code (longcode or shortcode) associated with the account that will be displayed as the originating number (number must be registered with the account).

message: Contents of the text message to be sent. Defined by the client. The message length is limited to 160 characters for most of the carriers but can be worked out case by case to explore the possibilities of increasing the number of characters beyond 160 per SMS message

meta_data1: This is an optional parameter that allows attaching client specific data (e.g. an account ID, a client ID or other customer data) to a specific outbound message.
The parameter can then be retrieved using MMS’s reporting options for outbound messages.
Up to 50 alphanumeric characters are supported.

auth_token: This is an optional parameter that can be used to send predefined token shared by MMS with clients for authenticating the requests when clients can’t send the basic authentication credentials in the http request header.
Please confirm with your account manager if this option is available for your messaging gateway API endpoint.

standard HTTP POST JSON sample request:
{
“source_addr”:“ShortCode/LongCode”,
“dest_addr”:“PhoneNumber”,
“app_id”:“xxxxx”,
“key”:“ABC123XXXX”,
“message”:“This is a test message”
}

Possible API Responses

{“Message”:“Successful”}
{“Message”:“Invalid application id or key.”}
{“Message”:“Message is required.”}
{“Message”:“Invalid Transportcode.”}
{“Message”:“Phone number is required.”}

HTTP POST JSON sample request with optional paramaters:
{
“source_addr”:“ShortCode/LongCode”,
“dest_addr”:“PhoneNumber”,
“app_id”:“xxxxx”,
“key”:“ABC123XXXX”,
“message”:“This is a test message”,
“meta_data1”:“ABC1234567890”
}

IMPORTANT: A “Successful” API response does not indicate that the message was delivered to the mobile device. A “Successful” API response simply indicates that the API call was properly formatted with valid parameters. Carrier Delivery Receipts (DLRs) that show message delivery status are available through the reporting UI or via API.

Feedback

Was this helpful?

Yes No
You indicated this topic was not helpful to you ...
Could you please leave a comment telling us why? Thank you!
Thanks for your feedback.

Post your comment on this topic.

Post Comment