16 Dec Send Mass SMS Message Procedure

 

The Send Mass SMS Message procedure is designed to be used when a large quantity of messages needs to be sent in a short period of time a message to a list of recipients. The answer of each message is synchronously; meanwhile the delivery receipt of each message is asynchronous (please see Delivery Receipt of a Message section).

To send a message the request must be submitted one of the following URLs:

HTTP (non-SSL):

HTTPS (SSL) *recommended*:

 

1.1 HTTP Methods

For the Send SMS Message procedure, the POST HTTP method must be used.

1.2 Authentication Information

All requests require API Key and API Secret authentication credentials. Account Administrators can login to view their account API Key and API Secret in the “My Profile > Settings” section.

The account’s API username (key), a 32 character random generated string.

In the header of the request with apiKey:

Parameter Name

apiKey

Description

The account’s API username (key), a 32 character random generated string.

Example:

Variable Type

String

Mandatory?

YES
In the header of the request with apiSecret:

Parameter Name

apiKey

Description

The account’s API username (key), a 32 character random generated string.

Example:

Variable Type

String

Mandatory?

YES
In the body of the request (for POST-based requests only):

Parameter Name

apiAuthenticationData

Description

A JSON object for your apiKey and apiSecret.

Example:

 

Variable Type

Object

Mandatory?

YES

 

1.3 Request Parameters

 

Request Parameters for “toList“:

Parameter Name

toList

Description

The recipient (“to”) MSISDNs. The destination number must be in international format and contain only digit values (ex: 17858716500 when sending to the USA).

Variable Type

String (1…*)

Mandatory?

YES
Request Parameters for “from“:

Parameter Name

from

Description

The Sender ID (“from”) to use in the SMS. The Sender ID may be a telephone number (including country code) or it may be alphanumeric (ex: Telintel). If an alphanumeric string is used the maximum length is 11 characters. Destination restrictions may apply.

Default = A generic, randomly generated number is used for the Sender ID.

Variable Type

String

Mandatory?

NO
Request Parameters for “message“:

Parameter Name

message

Description

The body of the SMS message.

Variable Type

String

Mandatory?

YES
Request Parameters for “datacoding“:

Parameter Name

datacoding

Description

The alphabet to send the message, use as follows:

  • 1= ASCII (160 character max)
  • 2= ASCII Latin (160 character max)
  • 8= UTF-16 (70 character max)
  • Default = GSM 7 Bits codification (160 characters max)

Variable Type

Numeric, integer

Mandatory?

NO

The request body will contain a JSON object.

For Example:

PHP example

Java example (with Apache HTTP Client)

 

1.4 Response Parameters

 

Key

Description

Variable Type

responseType

An ENUM that represents the return code for the response.

Please reference Response Codes table in Annex A.

String

requestId

An integer that represents the reference ID of the request (all transactions). Integer

requestResponseId

An integer representing the return code of the response / error.

Please reference Response Codes table in Annex A.

Integer

requestResponseDescription

A human readable text describing the results of the response / error.

Please reference Response Codes table in Annex A.

String

remainingBalance

Remaining account balance, after a message is sent. Double

toList

The recipient (“to”) MSISDNs.

The destination in international format containing only digit values (ex: 17858716500 = when the recipient is in the USA).

String