Introduction #
This article describes the error codes that are logged to the BPA Platform Event Log when a text message fails to be sent.
Errors are written to the Event Log using the format:
<error_message> Error Code: <error_code> Number: <mobile_number> From: <sender> Message: <text_message> Source Task Information: TaskName: <task_name> TaskId: <ID> TimeOfSubmission: <date_time_stamp>
where:
error_messageis as below.error_codeis as below.mobile_numberis the attempted destination mobile number.senderis the source address set in the global configuration — refer to the product help.text_messageis the text message body.- Source Task Information contains details of the task that sent the failed message. Note that the
date_time_stampis from when the task first submitted the message, not when it was re-attempted (either manually or otherwise).
Error Codes #
The following error codes are logged to the Event Log by the Send Text Message tool:
| Error Code | Error Message | Description |
|---|---|---|
| 0 | OK, no error | |
| 1 | Unknown | An unknown error has occured. Contact Support for more information. |
| 2 | Syntax error | A syntax error has been found in the message envelope; this could be in any element. |
| 3 | Login | The user credentials for the Message Gateway account (in the global configuration; refer to the product help) are incorrect. These must be corrected before the message queue can continue. |
| 4 | Already bound | Contact our Support department if this error is seen. |
| 5 | Invalid arguments | An error has been found in either the message envelope’s properties. |
| 6 | Invalid command | An error has been found in the message envelope’s commands. |
| 7 | Invalid message id | The text message contains an invalid ID. |
| 8 | Invalid destination address | The destination mobile number cannot be reached. Typically, this is because the number is too short or is a blank mobile number for example. |
| 9 | Invalid source address | The source address configured in the global configuration (refer to the product help) contains invalid charcters. |
| 10 | No access | Contact our Support department if this error is seen. |
| 11 | Message error | There is a problem with the text message contents or the message envelope. |
| 12 | Invalid response | An invalid response has been received from the provider to the Message Gateway. |
| 13 | Communication error | Data |
| 14 | Database error | This refers to the database used by the Message Gateway. Contact Support for more information. |
| 15 | UDH error | An error has been detected in the User Data Header of the text message; typically it contains problematic unicode data. |
| 16 | No credits left | The credits on the ToucanText account has expired; contact your business partner or account manager. |
| 17 | Busy | The Message Gateway has halted the queue until it has free resources to continue. |
| 18 | Too long | The text message body has exceeded the maximum size, which is 918 bytes; typically this is 1 byte per character but some can take up more. You must reduce the size of the erroring text message before re-queuing the message. |
| 19 | Expired | Contact our Support department if this error is seen. |
| 20 | No route | A destination route for the text message cannot be found. |
Error Codes for Messages That Stop the Message Queue #
If one of the following errors is seen, the Send Text Message tool attempts to resend the message every 15 minutes up to 120 minutes by default. After 120 minutes, the message queue is halted and an error written to the Event Log. Text messages will continue to be added to the queue; user intervention is required to resolve the error. Note that the Message Gateway Agent service must be restarted for the queue to start processing after the error has been resolved.
|
|
Error Codes for Single Message Failure #
The following error codes indicate a problem with a particular text message. However, text messages that come after it will not be held up.
|
|
