Successful Submission of SMS
For each successful submission of an SMS, the API would return a unique message ID (UUID) for that SMS campaign. The Client’s Application should capture the unique message ID and fetch a Delivery Report (DLR) against that corresponding message ID. This message ID then can be used to track the status of the message and receive the delivery report against this message ID through the delivery report URL specified by the client.
Response Formats
By default, the API URL generate responses in JSON format. One can also generate responses in XML, JSON formats. All we need to do is to add "&format=xml" (for XML format).
Response Parameters
The response parameters in case of error in API are tabulated below:
| Parameter | Description | Expected Values |
|---|---|---|
| status | Error code for your API call | Numeric Value A401,E601 etc |
| message | Error Message for your API call | String.Refer API Error codes section |
API Error Codes
When certain parameters of the API URL are not entered correctly, you will receive a response from the URL stating the type of error. These error descriptions will help you to pin-point the erroneous parameter in the URL and rectify it.
Following is the aggregated list of error codes which can be generally received while using the API in the below format:
| STATUS | MESSAGE |
|---|---|
| A400 | Api file not found in project |
| A401A | Method Not Implemented. |
| A401B | Method Not Found |
| A402 | Api Key not found. |
| A403 | Api Signature not found |
| A404 | Your api account got suspended |
| A405 | Api secret not found. |
| A406 | Request is not allowed from this ip |
| A407 | Header misconfigured |
| A408 | Api Signature not equal |
| A411 | Port number must be numeric |
| A415 | Invalid xml/Invalid Json |
| A416 | Invalid Message ID/Mobile |
| A417 | Invalid Message ID/Mobile |
| A418 | Invalid Group ID/Campaign |
| A419 | Invalid Group ID/Campaign |
| A430 | Invalid Group ID |
| A431 | Invalid Group ID |
| A432 | Campaign already completed/Campaign already cancelled |
| A433 | Schedule time already passed |
| A434 | Campaign within next 5 minutes cannot be modified/cancelled. |
| A434 | Invalid schedule time. Minimum 5 min time gap is required and 3 months from now. |
| E601 | Missing recipient |
| E603 | Missing message |
| E602 | Missing sender ID |
| E604 | SenderID must be less than 14 chars |
| E605 | Invalid Sender or Sender not allowed |
| E606 | Invalid schedule time. Minimum 5 min time gap is required and 3 months from now. |
| E606A | Batch size should be greater or equal to 1000 |
| E606B | Schedule minute should be in multiples of 15. Minimum 15 minutes |
| E612 | Invalid Template Matched |
| E607 | SMS length is exceeding 1000 characters |
| E607A | Unable to find gateway to sent sms. |
| E608 | No Valid mobile numbers found |
| E608A | Your daily usage limit exceeded |
| E609 | An error occured while saving group details |
| E610 | Unable to write to temp files |
| E611 | Unable to process your request. try again |
| A420 | Group name/id missing |
| A421 | Group is empty/Invalid group |
| A422 | Invalid mobile number |
| A423 | Group name/number missing |
| A424 | Group Name does not exist! |
| A425 | Number does not Exist |
| H601 | Insufficient credits. Total "x". Required "y" more credits |
| A430 | Group name/id missing |
| A431 | Group is empty |
| A432 | Invalid mobile number |
| A433 | Keyword name/number missing |
| A434 | Keyword not found |
| A435 | Keyword is not active |
| A436 | No sender found! |
| E500 | Please provide URL to redirect |
| E501 | Txtly Already Exists. Please try another one. |
| E502 | Please attach a file |
| E503 | Invalid file format. Upload valid file. |
| E504 | File size exceed. Maximum 50000 Kb. |
| E505 | File upload failed. Please try again. |
SMS Status Codes-HTTP API(On Submission)
When we receive an API call for sending SMS one of the following status code is attached at the application level.
The common status codes received while using the API are:
| Status | Description |
|---|---|
| AWAITED-DLR | Mobile number has been accepted and submitted to the operator. Awaiting delivery report from the operator |
| INVALID-NUM | In case any invalid number present along with the valid numbers. |
SMS Status Codes-XML/JSON API(On Submission)
There could be one or more nodes in an XML API, each of those nodes can have a different status code on submission. The common status codes received while using the API are:
| Status | Description |
|---|---|
| AWAITED-DLR | Mobile number has been accepted and submitted to the operator.Awaiting delivery report from the operator |
| DNDNUMB | Mobile number is DND. |
| OPTOUT-REJ | Opt out from subscription. |
| INVALID-NUM | In case any invalid number present along with the valid numbers. |
| SENDER-ID-NOT-FOUND | In case the sender ID given in any one of the nodes is not available |
| INV-TEMPLATE- MATCH | In case the message given in any one of the nodes does not match the template approved for the sender ID in the same node |
| MAX-LENGTH | In case the message given in any one of the nodes exceeds the maximum of 1000 characters |
SMS Status Codes(Operator Level)
On submission of a message to any operator, We associate one of the following status codes to every SMS in order to track the status. The common status codes received while using any API are as follows:
| Status | Description |
|---|---|
| NO-CREDITS | Insufficient credits. |
| SERIES-BLOCK | Mobile number series blocked. |
| INV-NUMBER | Invalid number. |
| SERVER-ERR | Server error |
| SPAM | Spam SMS |
| SNDRID-NOT-ALLOTED | Sender ID not allocated. |
| BLACKLIST | Blacklisted number |
| TEMPLATE-NOT-FOUND | Template not mapped. |
| INV-TEMPLATE-MATCH | Template not matching approved text. |
| SENDER-ID-NOT-FOUND | Sender ID not found. |
| DNDNUMB | DND registered number. |
| NOT-OPTIN | Not subscribed for opt-in group. |
| TIME-OUT-PROM | Time out for promotional SMS. |
| DELIVRD | SMS successfully delivered. |
| INVALID-SUB | Number does not exist. / Failed to locate the number in HLR database. |
| ABSENT-SUB | Telecom services not providing service for the particular number. / Mobile Subscriber not reachable. |
| HANDSET-ERR | Problem with Handset or handset failed to get the complete message. / Handset doesn’t support the incoming messages. |
| BARRED | End user has enabled message barring system. / Subscriber only accepts messages from Closed User Group [CUG]. |
| NET-ERR | Subscriber’s operator not supported. / Gateway mobile switching error. |
| MEMEXEC | Handset memory full. |
| FAILED | SMS expired due to roaming limitation. / Failed to process the message at operator level. |
| MOB-OFF | Mobile handset in switched off mode. |
| HANDSET-BUSY | Subscriber is in busy condition. |
| SERIES-BLK | Series blocked by the operator. |
| EXPIRED | SMS expired after multiple re-try. |
| REJECTED | SMS Rejected as the number is blacklisted by operator. |
| OUTPUT-REJ | Unsubscribed from the group. |
| REJECTED-MULTIPART | Validation fail [SMS over 160 characters] |
| UNDELIV | Failed due to network errors. |
| NO-DLR-OPTR | In case operator has not acknowledge on status report of the SMS. |