Ginota SMS API returns a response in 2 parts:
A standard successful SMS Send Response shall return status code as '0' and a unique messageId to identify each SMS send request:
| HTTP Header | 200 OK |
| Content | { |
| HTTP Header | 200 OK |
| Content | { |
| Parameter | Description |
|---|---|
| status | Status code. '0' indicates Successful Request. (For Error codes, please refer to Error Response Code section below) |
| desc | Description. 'Ok' indicates Successful Request. (For full description of the Error codes, please refer to Error Response Code section below) |
| messageId | Unique ID to identify a successful SMS send request. Used to trace and match against the ID returned in Delivery Receipt. |
| parts | Number of concatenated message parts used to send customers SMS content. |
| txnRef | Unique internal transaction reference supplied by user in the API request |
| Response Code | Description | Causes |
|---|---|---|
| 1 | Invalid request | Missing mandatory input parameter or input data is invalid. |
| 2 | System error | Internal error related to database interaction or routing. |
| 3 | System busy | Ginota gateway is busy in delivering messages. |
| 4 | Destination address unreachable | The destination number cannot be identified as it is not associated to any supported country by Ginota or is in incorrect format. |
| 7 | Access denied | The API Key and API Secret is either unavailable, inactive or invalid in Ginota. (Note: Both values are case sensitive and value of API Key has been URL-encoded) |
| 21 | Invalid source address | The alphanumeric support feature is not set up for your account. |
| 22 | Invalid destination address | The routing of destination number is not set up for your account. |
| 23 | Invalid message | Message content appears to be an empty string. |
| 24 | Message too long | Message content exceeds message size limits of Ginota. |
| 25 | Contains banned words | Message content is rejected due to suspected banned words used. |
| 27 | Destination address blacklisted | The destination number has been blacklisted. |
| 28 | Destination address not whitelisted | Whitelist feature is enabled for your account. This destination number is not whitelisted. |
| 41 | Invalid account | Invalid account in billing engine. |
| 44 | Insufficient balance | Your account balance is insufficient to send out the SMS created/scheduled. |