Checking SMS Status -PULL
To check status of any sent SMS campaign, you must have message id only (not group ID) of the respective message(s). You can only check status for messages which have been sent on the same day. If using POST method for pulling messages status, then statuses for maximum 25 messages can be pulled at a time. Here is an API for checking the status of an SMS in the following format:
curl -X POST \
'<BASE_URL>&method=sms.status&id=612c4378-84b3-496c-9123-64f248a20b88:1'
API Parameter Specifications
The API parameter specifications are described in the following sections.
Mandatory Parameters
The mandatory parameters in the HTTP API are tabulated below:
Parameter | Description | Expected Values |
---|---|---|
BASE_URL | BASE URL of your SMS Service | URL |
method | Predefined method | sms.status |
id | Message ID(s), comma separated | message id of messages sent for the same day |
Optional Parameters
The optional parameters in the HTTP API are tabulated below:
Parameter | Description | Expected Values |
---|---|---|
format | Output format should be as specified by this variable | XML/JSON/JSONP. Default response will be in JSON |
numberinfo | Flag to query service provider and location data | 1 or 0 |
page | Page number to fetch status details of a pariticular page | 1 or more |
Example Responses
JSON
{
"status": "OK", "data": [
{
"id": "612c4378-84b3-496c-9123-64f248a20b88:1",
"mobile": "88xxxxxxxx",
"status": "DELIVRD",
"senttime": "2017-02-06 14:54:25",
"dlrtime": "2017-02-06 14:54:26",
"custom": "",
"custom1": null,
"custom2": null,
"provider": "",
"location": ""
} ],
"message": "Processed Successfully"
}
Error Response
{
"status": "A417",
"message": "Invalid Message ID/Mobile. No details found"
}
Response Data
Field | Description |
---|---|
status | It indicates the success or failure of your request. |
message | It indicates the success or failure message. |
data | All the response is wrapped in side data |
sms | Each number will be wrapped inside sms |
id | Website message id for your reference |
custom1 | Custom message id 1 if you provide one |
custom2 | Custom message id 2 if you provide one |
mobile | Mobile number the sms will be sent |
status | status of the message |
custom | Custom message id if you provide one |
senttime | message sent time |
dlrtime | message delivered time |
provider | provider of the mobile numer |
location | Registered location of the mobile number |