Understanding Batch SMS Response Codes

This document goes over understanding SMS responses using our API.

Responses

We use conventional HTTP response codes to indicate the success or failure of an API request. In general:

2xx indicate success. 4xx indicate an error that failed given the information provided (e.g., a required parameter was omitted). 5xx errors indicate an error with ours servers (these are rare).

Sample Success Response

Upon a successful send request, our server will respond with a 200 (success) HTTP response code, and respond with campaign json.

{
   "id":"fd9157b74bd3475d8716a69683066f0f",
   "name":null,
   "routeId":"mglobal",
   "shortenUrls":false,
   "spreadHours":0,
   "excludeOptouts":true,
   "excludeDuplicates":false,
   "scheduleDateTime":null,
   "recipients":[
      {
         "originator":"Brand",
         "recipient":"440000001",
         "text":"Test Message",
         "reference":"ref-001",
         "routeId":null
      }
   ]
}

Sample Error Response

{
   "code":401,
   "message":"Unauthorized"
}

Response Codes

To see a full list of our Response codes, please click here