Status codes

Summary

This is a summary of what each status code group means. The way our status blocks works is that, for example, if the code starts with 1 then the status belongs to the status group Info. This allows us to add new status codes while still allowing your software to handle these new status codes without being explicitly developed for them.

Code block

Name Code block Description
Accepted 1 Informative statuses informing where the message is in the pipeline.
Success 2 If the message ended in a user defined way such as Expired or DeliveredToHandset.
Rejection 4 If the message was undeliverable or other errors which is out of the control for the delivery service.
Error 5 If the message was undeliverable or other errors which is out of the control for the delivery service.

Info

Name Status code Code block Description
Accepted 101 Info The message has been accepted for processing.
Queued 102 Info The message has been queued to be sent out.
Funded 103 Info The cost of the message has been deducted from the balance and can be sent out.
Refunded 104 Info The message has been refunded i.e. its price has been returned to the account balance
Sending 110 Info The message is sent.
DeliveredToGateway 111 Info The message has been delivered to the gateway.
DeliveredToCarrier 112 Info The message has been delivered to the operator where the number is registered.
DeliveredToGSM 113 Info The message has been sent out to the GSM network.
QueuedAtGateway 114 Info The message has been queued in the gateway.

Success

Name Status code Code block Description
DeliveredToHandset 201 Success The message has been sent to the current recipient.
Expired 202 Success The expiry date of the message has passed before the message was delivered.
Canceled 203 Success The message was canceled by the user.

Rejection

Name Status code Code block Description
InsufficientFunds 402 Rejection The account trying to send does not have enough balance to send the SMS.
SenderRejected 403 Rejection The sender has been denied, given when the sender is considered fraudulent or the ownership of the sender has not been properly verified.
ContentRejected 404 Rejection The content of the message is not allowed by the specific operator and/or country, e.g. hate speech, adult content, etc.
RecipientRejected 405 Rejection The recipient is invalid.
GenericRejected 406 Rejection The message was rejected for a reason other than the options above
InvalidSender 407 Rejection The message sender is invalid. Eg. Sender is too long, contains illegal characters etc
InvalidContent 408 Rejection Message content is invalid. Eg. illegal characters, is to long etc.
InvalidRecipient 409 Rejection The recipient of the message is invalid, e.g. the recipient is not a valid MSISDN.
MissingSmsSubscription 410 Rejection The recipient does not have an SMS subscription and can therefore not recieve SMS

Error

Name Status code Code block Description
InternalError 500 Error An unknown error occurred.
UnknownSubscriber 501 Error The network subscriber doesn't exist
SubscriberUnreachable 502 Error The network subscriber was not available and therefore cannot receive the message.
SubscriberOffline 503 Error The subscriber is currently offline, delivery will be retried once the subscriber is back online
DeliveryToGatewayFailed 511 Error The message could not be handed over to the next gateway.
DeliveryToCarrierFailed 512 Error The message could not be handed over to the operator.
DeliveryToGSMFailed 513 Error The message could not be added to the GSM network.
DeliveryToHandsetFailed 514 Error The message could not be delivered to the recipient's phone.
GenericDeliveryFailure 515 Error General delivery failure.
GatewayError 516 Error An unknown error occurred at the gateway.
Unknown 599 Error The message was delivered upstream but no delivery receipt has been received or a delivery receipt that could not be interpreted was received.