Error codes
Response envelope
Every SMS (v2) and Push (v1) response is wrapped in a standard envelope:
json
{
"message": "Success",
"code": "8_10_200",
"success": true,
"data": {
"messageId": "329e121b-aa8e-47e7-ae30-be8a40a38d4a",
"errorCode": 0,
"description": null,
"destination": "<Recipient_Phone_Number>"
},
"version": "2"
}
| Field | Description |
|---|---|
success | Boolean outcome of the request. |
message | Human-readable status, e.g. Success, Invalid Sender. |
code | service_product_httpStatus — see below. |
data | Payload; for sends it contains messageId, errorCode, description, and (SMS v2) destination. For SMS bulk sends, data is an array with one item per recipient. |
data.errorCode | Domain result code; 0 on success. |
version | API version that generated the response. |
The code scheme
The code field is service_product_httpStatus. The middle segment identifies the product:
code prefix | Product |
|---|---|
8_10_* | SMS |
8_23_* | |
8_13_* | Push |
For example, 8_10_200 is an SMS success and 8_13_201 is a Push campaign created.
errorCode values
errorCode | message | HTTP | Meaning | Resolution |
|---|---|---|---|---|
0 | Success | 200 / 201 | Request accepted. | — |
2 | Invalid Sender | 400 | The Source is not provisioned for your tenant. | Use an approved sender ID. |
5 | Unauthorized Access | 400 | Credential or access problem. | Check api-key, Tenant, and IP whitelist. |
10 | Template Does Not Exist. | 400 | The referenced template was not found. | Use a valid, approved template. |