SMS Outbound Status Codes
This document provides an overview of the status codes returned by the different SMS Outbound applications. They are visible in the Retarus Enterprise Administration Portal (EAS) in the SMS Reporting and Report Archive sections.
Status codes specification
The Status Code is a three-digit numeric code providing additional information about the state of the message. The first two digits, specified in the following section, are meant to provide a simple classification of the possible outcomes, while the third one is used to differentiate between different states.
Processing state
The first digit in the status code indicates the current state of the SMS. This provides a simplified overview of the most important information.
Value | Status | Description |
|---|---|---|
1 | Accepted / in progress | The SMS was accepted, and no final state is available, meaning that the message is currently waiting for transmission (e.g. because the scheduled delivery time is not reached) or being processed by the Retarus infrastructure. |
2 | Sent | The delivery of the SMS was successful. |
3 | Canceled | The transmission was canceled by the customer. |
4 | Temporary error | There was a temporary error delivering the SMS. Retrying the transmission at a later point would likely be successful. |
5 | Permanent error | There was an unrecoverable error delivering the SMS. Retrying the transmission would likely lead to another failure. |
Domain
The second digit in the status code indicates the domain/entity which is responsible for the current status. This can be useful to guide the analysis in case of errors.
Because of the different implementation by different service providers, in some cases the information can only be estimated based on the information available and it might not be completely accurate.
Value | Domain |
|---|---|
0-1 | Retarus |
2-3 | Reserved |
4-5 | Carrier / Aggregator |
6 | Recipient |
Status codes
The following table documents the status codes returned by the Retarus Outbound SMS backend. The fields are as follows:
Status Code: Status code as specified in Status codes specification.
Step: The current step of the SMS transmission (see Processing state).
Domain: The domain responsible for the current state (see Domain).
Process Status: Indicates the processing state of the message.
Status: Provides more details about the current status of the message.
Description: Detailed description of the status.
Status Requested: Indicates whether the field depends on the customer having requested a status for the message or not.
Status code | Step | Domain | Process status | Status | Description | Status requested |
|---|---|---|---|---|---|---|
100 | Accepted / in progress | Retarus | OPEN | <empty> | Pending SMS, not yet scheduled. | <Irrelevant> |
101 | Accepted / in progress | Retarus | OPEN | <any> | In re-try state (e.g., during a connection error to service provider). | <Irrelevant> |
110 | Accepted / in progress | Retarus | RUNNING | <any> | SMS was sent, but no delivery notification was received. | True |
111 | Accepted / in progress | Retarus | KILL | <any> | SMS was sent, but cancelled and no delivery notification has been received. | True |
200 | Sent | Retarus | DONE | SUC_ACC | Message Sent successfully (without delivery notification). | False |
210 | Sent | Retarus | DONE | SUC_FIN | Message Sent successfully (with delivery notification). | True |
300 | Canceled | Retarus | CANCELED | <empty> | Transmission was cancelled before the initial delivery attempt. | <Irrelevant> |
300 | Canceled | Retarus | CANCELED | <any> | Transmission was canceled after the initial delivery attempt. | <Irrelevant> |
400 | Error | Retarus | <any> | <any> | Unknown Retarus error (temporary). | <Irrelevant> |
401 | Error | Retarus | DONE | TIMEOUT | Message sent, but no Delivery Notification received from the carrier within the timeout period. | True |
402 | Error | Retarus | DONE | NOT_ACC_FIN | Failed; delivery to the provider was/is not possible (final). | <Irrelevant> |
403 | Error | Retarus | DONE | NOT_ACC_REC | Failed; delivery to the provider was/is not possible and maximum number of attempts reached (recoverable). | <Irrelevant> |
407 | Error | Retarus | DONE | CON_ERR | Failed; all retry attempts were unsuccessful (Retarus network error). | <Irrelevant> |
408 | Error | Retarus | DONE | SEND_ERR | Internal Retarus Send error (in most cases, the SMS has arrived anyway). | <Irrelevant> |
409 | Error | Retarus | DONE | STATUS_ERR | Internal error during the query for the delivery notification. | True |
440 | Error | Carrier / Aggregator | DONE | FAILED_FIN | Failed; delivery notification returns this status (unknown provider error, temporary). | True |
441 | Error | Carrier / Aggregator | DONE | FAILED_FIN | Failed; delivery notification returns this status (provider error, temporary). | True |
442 | Error | Carrier / Aggregator | DONE | TIMEOUT | Sent, but the validity period was exceeded (provider error). | True |
460 | Error | Carrier / Aggregator | DONE | FAILED_FIN | Failed; delivery notification returns this status (unknown provider error, temporary). | True |
461 | Error | Receiver | DONE | TIMEOUT | Sent, but the validity period was exceeded (unknown error). | True |
462 | Error | Receiver | DONE | TIMEOUT | Sent, but the validity period was exceeded (absent subscriber) | True |
463 | Error | Receiver | DONE | FAILED_FIN | Failed; delivery notification returns this status (absent subscriber, temporary) | True |
500 | Error | Retarus | <any> | <any> | Failed due to unknown Retarus error (permanent). | <Irrelevant> |
501 | Error | Retarus | DONE | INVALID_DST | Failed; invalid destination number (e.g., 999999). | <Irrelevant> |
509 | Error | Retarus | DONE | BLOCKED | Number rejected by Retarus on recipient or provider request. | <Irrelevant> |
540 | Error | Carrier / Aggregator | DONE | FAILED_FIN | Failed; delivery notification returns this status (Unknown provider error, permanent). | True |
548 | Error | Carrier / Aggregator | DONE | FAILED_FIN | Failed; delivery notification returns this status (invalid source number). | True |
549 | Error | Carrier / Aggregator | DONE | FAILED_FIN | Failed; delivery notification returns this status (rejected by destination operator, permanent) | True |
561 | Error | Receiver | DONE | FAILED_FIN | Failed; delivery notification returns this status (invalid destination). | True |
569 | Error | Receiver | DONE | FAILED_FIN | Failed; delivery notification returns this status (rejected on end user request). | True |