Send personalised SMS with different content per destination

Sends different message content to different destination numbers in a single API
call, using one sender ID. Multiple message bodies are separated using the ||-||
separator, and multiple destinations are separated using a comma; message bodies
map to destinations in the order they are listed.

Authentication is performed using username and password passed as query
parameters — there is no separate header-based authentication for this API.

Response codes

CodeMeaning
1701Message(s) submitted successfully. Response format: 1701|<destination>:<messageid>, repeated per destination
1702One of the required parameters was not provided
1703User authentication failed
1704Invalid value in type field
1705Invalid message content
1706Invalid destination
1707Invalid sender (source) value
1708Invalid value for dlr field
1709Bind failed
1710Unknown error
1713Too many destinations in a single request
1715Response timeout
1025Insufficient user credit
1028Message flagged as spam
1032Destination is on DND (Do Not Disturb) list
1033Message content does not match an approved template
1035User has opted out
1041Duplicate message detected
1042Explicit DND applies to this destination
1813Error occurred while creating the job file
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Username of the HTTP account

password
required

Password of the HTTP account

integer
enum
required

0: delivery report not required, 1: delivery report required

Allowed:
integer
enum
required

Message type — 0: Text, 1: Flash, 2: Unicode, 4: WAP Push, 6: Unicode-Flash

Allowed:
string

Destination link for WAP Push messages (type=4 only). Not required otherwise.

string
required

Sender ID shown on the message

string
required

One or more message bodies, URL-encoded, separated by the literal sequence ||-|| when sending different content to different destinations.

string
required

One or more destination numbers, separated by a comma. Each destination maps in order to the corresponding message body.

string

Optional campaign name used for tagging/reporting.

string

Optional user-defined field for tagging each record or message, comma-separated if used per message.

Responses

400

Malformed request — a required query parameter is missing

401

Authentication failed — invalid username or password

500

Internal server error while processing the request

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain