Errors Codes
In the event of receiving an HTTP 40x response from a Confirm API request, the response body will contain a JSON document showing a response code and human readable error string.
{
"result_code": "100",
"result_message": "Un-parsable Request Document",
"client_reference": "...if provided during original request..."
}
Result Code List
| Result Code | Should Retry | Result Message |
|---|---|---|
| -4 | No | Unsupported Media Type |
| -3 | No | Not Acceptable |
| -2 | No | HTTP method not allowed |
| -1 | Yes | There has been an internal error! |
| 0 | No | Message successfully submitted |
| 1 | Yes | Throttled - submit rate exceeded - please re-submit |
| 2 | No | Authentication Failure |
| 99 | Yes | Timeout submitting message - aborted |
| 101 | No | Missing or invalid From Address |
| 102 | No | Missing or invalid DestinationAddress |
| 106 | No | The request was missing an outcome_url element |
| 107 | No | The outcome_url element contained a badly formed URL |
| 108 | No | The request was missing a ‘how_many_digita’ element inside collect_digits |
| 109 | No | The how_many_digits element contained an invalid number |
| 110 | Yes | The request did not specify a language |
| 111 | Yes | The request specified an un-recognized or unsupported language |
| 112 | Yes | The workflow requested does not exist or is not available for use |
| 113 | Yes | The pin-length requested was outside of the permitted range |
| 114 | Yes | The custom message text requested was longer than the permitted range |
| 115 | Yes | The custom message text requested did not include a ${pin} placeholder |
| 116 | No | The request specified an un-recognized or unsupported charge profile |
| 200 | No | The request could not be handled as there is no route for that destination |
| 201 | Yes | The request submission failed due to unexpected internal error |
| 202 | No | The request was dropped due to routing rule |
| 203 | No | The request was dropped as it was identified as spam |
| 204 | Yes | The request could not be accepted due to a network failure |
| 210 | No | The submitted PIN code was not of the correct format |
| 211 | No | The submitted PIN was not the expected PIN for this request |
| 212 | No | The requested session was not expecting a PIN |
| 213 | No | The submitted PIN was not the expected PIN for this request and this now exceeds the maximum allowed number of incorrect attempts |
| 214 | No | The requested session is no longer active |
| 215 | No | The requested session has been cancelled |
| 216 | No | The maximum number of resend PIN requests has been exceeded |
| 299 | No | The requested operation was not permitted on this account |
Note: First four result codes have Negative values