Error codes

Response envelope

Every v1 response (SMS and Push) 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 },
  "version": "1"
}
FieldDescription
successBoolean outcome of the request.
messageHuman-readable status, e.g. Success, Invalid Sender.
codeservice_product_httpStatus — see below.
dataPayload; for sends it contains messageId, errorCode, and description.
data.errorCodeDomain result code; 0 on success.

The code scheme

The code field is service_product_httpStatus. The middle segment identifies the product:

code prefixProduct
8_10_*SMS
8_23_*WhatsApp
8_13_*Push

For example, 8_10_200 is an SMS success and 8_13_201 is a Push campaign created.

errorCode values

errorCodemessageHTTPMeaningResolution
0Success200 / 201Request accepted.
2Invalid Sender400The Source is not provisioned for your tenant.Use an approved sender ID.
5Unauthorized Access400Credential or access problem.Check api-key, Tenant, and IP whitelist.
10Template Does Not Exist.400The referenced template was not found.Use a valid, approved template.