Customer-facing translation
Base statuses
Status code | Meaning | When? | “Translation” |
|
---|---|---|---|---|
0 | Unknown | A message with the given id was not found. It is possible that the message was submitted, but not yet processed by a worker. Or that such a message doesn't exist. |
| Sending |
1 | Rerouting | The message was impossible to deliver to given supplier and has to be routed again. |
| Sending |
2 | Delivered | The message was sent and the Delivery Receipt was received as sent to us by the Mobile Network | Recipient has received the message on their mobile phone. | Delivered |
3 | Expired | Message delivery failed and the message expired (SMSC will no longer try to deliver it) as notified by Mobile Network | Recipient could not be reached as their phones does not have reception. This can have multiple reasons, e.g., recipient has turned off his phone, recipient is in a black spot, recipient is overseas. | Undeliverable |
4 | Deleted | The message was deleted by the Mobile Network |
| Undeliverable |
5 | Undeliverable | Message undeliverable as determined by Mobile Network | Message could not be sent to recipients. This can have mulitple reasons, e.g., the number | Undeliverable |
8 | Rejected | Message rejected by Mobile Network |
| Undeliverable |
9 | Failed to charge sender | Failed to change MMS message sender |
|
|
10 | Submitted | Send request received from the customer but not yet routed and sent to a mobile network. May be temporarily unroutable due to inactive outbound bind. | [suggesting to merge this with sent as this is hard to understand for a technical person. ] | Sending |
11 | Sent | The message has been sent to the mobile network - delivery notification has not yet been received. | Message has been sent, but we have not yet received the delivery receipt back. Recipients likely have already receieved the message and there is usually a small delay between receiving the message and getting the delivery state back into the Message Centre. Some messages will also stay in “Send” state for longer when we cannot reach the recipient in the first attempt and have to try to reach them multiple times. This can be because the recipient has turned off their phone or are in a location without reception. We try to send our messages repeatily for 72 hours. If we can’t reach the recipient during this time, we will expire the message. | Sending |
12 | Not deliverable | There's no Routing defined for the destination address to send the message to the mobile network. |
| Undeliverable |
13 | OA Whitelist | Origin Address whitelist validation failed |
| Undeliverable |
14 | Content filter block | The message has been blocked by the content filter |
| Undeliverable |
15 | Invalid content | Message content does not include the originator's name |
| Undeliverable |
16 | Submitted to outbound | MMS message sent from worker to MMS outbound |
| Sending |
Priority relates to the status returned when a single message sent to us is longer than 160 characters and is sent as multiple parts to the SMSC making it possible for each message part to have a different status.
If message parts have different statuses, the status returned in the query process will be the lowest priority status within the relevant message parts. It is possible for one message part to show as delivered while the others show as sent. A multipart message will not display on a handset until all message parts are delivered so the valid total message status is sent and this is what your message status query will return. You can log into the user web application on MC5 and view the status of the individual message parts as each Outbound message to the SMSC shows as a separate entry in the SMS Out Volume Report
Validation failure status codes
Status code | Final | Meaning | When? |
---|---|---|---|
-101 | Y | No username | No username was provided in the request |
-102 | Y | No password | No password was provided in the request |
-103 | Y | No document id |
|
-104 | Y | Invalid recipient | Recipient number invalid - validation rules - numeric length: 8-16 inclusive |
-105 | Y | Invalid source | Sender number did not meet validation rules in the system for example alpha <2, 11>, digit < 3, 16> |
-106 | Y | Empty text | The SMS text was empty |
-107 | Y | Text is too long | The SMS text is too long |
-108 | Y | Empty request | The MMS request empty |
-109 | Y | Invalid rotation algorithm provided | Available algorithms are: max_rotation, conversation |
-110 | Y | Invalid encoding name | Available encodings are e.g. "utf-16", "gsm", "iso-8859-1" etc. |
-111 | Y | Past scheduled data | The scheduled date of the MMS message is in the past |
-112 | Y | Max delay exceeded | The scheduled date of MMS exceeds the availability period of the attachment |
-200 | Y | Invalid username/password | Invalid username/pass |
-201 | Y | User disabled | User disabled |
-202 | Y | User blocked | User blocked" |
-203 | Y | Password expired | The user tried to log in with expired an password |
-210 | Y | Insufficient credits | No credits |
-230 | Y | Document ID not matched | The user does not have the rights to check the message status |
-240 | Y | Invalid (not supported) replyTo value |
|
Auth (JWT)
Status code | Final | Meaning | When? |
---|---|---|---|
-400 | Y | Invalid Request |
|
-401 | Y | Invalid Payload |
|
Attachments
Status code | Final | Meaning | When? |
---|---|---|---|
-500 | Y | Not accessible | The attachment manager cannot be reached |
-501 | Y | Invalid attachments | Either the attachment is not available or there was an upload problem |
-502 | Y | Missing attachments | Attachment not found |
-503 | Y | Too many attachments | Attempt to send more attachments in a single request than allowed |
-504 | Y | Unknown Error | Generic error for anything unexpected |
-505 | Y | Invalid user id | Invalid user id in attachment manager request |
-506 | Y | Invalid customer id | Invalid customer id in attachment manager request |
-507 | Y | Non existing attachments | Attachment does not exist |
-508 | Y | Attachment retention period exceeded | The scheduled date of MMS exceeds the availability period of the attachment |
-509 | Y | Attachment processing error | One of several errors occurred while processing the attachment - the response message should have more info |
-510 | Y | Attachment not available on date | The attachment will not be available on a specific date |
Errors
Status code | Final | Meaning | When? |
---|---|---|---|
-910 | Y | SMSC error | Send failure |
-999 | Y | Internal Error |
|
Incoming Message
Status code | Final | Meaning | When? |
---|---|---|---|
101 | Y | Received | Received incoming SMS |
103 | Y | Sent error | Failed to reply SMS |
104 | Y | Forwarded | Successful replay SMS |
105 | Y | Dropped | Dropped processing of SMS message |