Use this endpoint to send an SMS to either a single or multiple recipients.
Sending to multiple recipients
This same endpoint allows you to send the same text message to multiple recipients. To do this, in the to parameter just enter the mobile number of the recipients separated with a comma (",").
Long text messages
When using the API to send a long message, the system will automatically check to see if the the messages will need to be concatenated and sent. If it decides that a message will need to be concatenated, when the message is sent, your response from the API will show multiple message_id's. Below is an example of such a response:
{
"status": "success",
"result": [
{
"message_id": "29756",
"status": "pending"
},
{
"message_id": "29757",
"status": "pending"
}
]
}
About the callback parameter
callback parameterIf specified, each DLR for an outgoing SMS will be sent to the URL provided using the POST method. Webhook definition is in JSON.
The timestamp parameter will display the date and time (in UTC). If the message has been delivered it will display the date and time of the message delivery. If the message is in any other state, it will display the date and time of when the message was sent.
{
"query": {
"id": "1234",
"status": "Delivered",
"timestamp": "2024-10-22T15:57:42.138Z"
}
}
Message Status
| Status | Description |
|---|---|
| Scheduled | The message is scheduled. Delivery has not yet been initiated. (Intermediate) |
| Enroute | The message is in enroute state. (Intermediate) |
| Delivered | Message is delivered to destination. (Final) |
| Expired | Message validity period has expired. (Final) |
| Deleted | Message has been deleted. (Final) |
| Undeliverable | Message is undeliverable. (Final) |
| Accepted | Message is in accepted state. (Final) |
| Unknown | Message is in invalid state. |
| Rejected | Message is in a rejected state. (Final) |
| Skipped | The message was accepted but not transmitted or broadcast on the network. (Final) |