Send a bulk SMS message

Submits an SMS message (plain text, flash, Unicode, WAP Push, or long/concatenated message) to one or more destination numbers over HTTP. All parameters, especially message and url, must be URL-UTF-8 encoded before submission.

The response is returned as plain text in the format: <Error_Code>|<destination>|<message_id>. For multiple destinations, each result is comma-separated in the same order as submitted.

| Response Code | Meaning | |---|---| | 1701 | Success — message submitted. Response format: 1701\|<CELL_NO>\|<MESSAGE_ID>. Use the message ID to map delivery reports later. | | 1702 | Invalid URL — one or more parameters were missing or left blank | | 1703 | Invalid value in username or password | | 1704 | Invalid value in type | | 1705 | Invalid message | | 1706 | Invalid destination | | 1707 | Invalid source (sender) | | 1708 | Invalid value for dlr | | 1709 | User validation failed — safe to retry | | 1710 | Internal error | | 1025 | Insufficient credit — batch aborted at this destination | | 1715 | Response timeout — do not resubmit the same message | | 1032 | DND reject | | 1028 | Spam message |

Standard SMPP v3.4 error codes may also be returned where applicable. Apart from error code 1709, do not retry re-sending the message for any other error code (including SMPP v3.4 error codes).

Multi-destination behavior: if a request contains multiple destinations, the batch is aborted immediately on any error other than "Invalid Destination" — in that case the invalid entry is skipped and processing continues with the next destination. If the SMPP server goes down mid-request, the API retries a fixed number of times before aborting the batch at that destination (code 1709 appended to the response). If credit runs out mid-request, the batch is aborted at that destination with code 1025 appended.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Username of the HTTP account.

string
required

Password of the HTTP account.

integer
enum
required

Message content type: 0 = Plain text (GSM 03.38), 1 = Flash (GSM 03.38), 2 = Unicode, 3 = Reserved (not for use), 4 = WAP Push, 5 = Plain text (ISO-8859-1), 6 = Unicode Flash, 7 = Flash (ISO-8859-1).

integer
enum
required

Whether a delivery report is required. 0 = not required, 1 = required.

Allowed:
string
required

Destination mobile number(s), with or without a leading plus (+) sign. Multiple numbers can be submitted comma-separated (the comma must be URL encoded).

string
required
length ≤ 18

Sender ID shown on the recipient's device. Max 18 characters if numeric, max 11 characters if alphanumeric. To display a leading plus sign on the handset, prefix it here (URL encoded). The SMSC may enforce additional restrictions on this field.

string
required

Message content to send, URL-UTF-8 encoded. Supports long (concatenated) messages — every 153 characters counts as one message part for plain text (268 for Unicode), with the remainder reserved for reassembly metadata. For WAP Push (type=4), this is the text displayed to the user. For Unicode types (2, 6), content should be encoded in UTF-16BE hex.

string

Link to include when sending a WAP Push message (type=4). Not required for other message types; if supplied for other types it is ignored. Must be URL encoded with UTF-8 (including non-ASCII domain names).

Responses

400

Bad request — malformed or incomplete query string.

401

Unauthorized — credentials rejected before reaching the SMSC layer.

500

Internal server error on the API gateway.

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