Child pages
  • SMS Status Codes
Skip to end of metadata
Go to start of metadata

The following status codes are used. These are defined in

https://source.sakaiproject.org/contrib/sms/sms/trunk/api/src/java/org/sakaiproject/sms/model/hibernate/constants/SmsConst_DeliveryStatus.java

SMS_TASK

STATUS_CODE

Explanation

Tool icon

S (Sent)

All messages for this task have been sent to the gateway. Delivery reports are awaited.

(tick)

F (Failed)

The maximum retry count for the task has been reached, mark task as failed and do nothing further with it.

(error)

X (Expired)

The expiry time for this task passed without it being delivered successfully.

(error)

P (Pending)

Messages are awaiting delivery to the gateway, for example because the task is scheduled for delivery at a later date/time.

R (Retry)

Rescheduled for later delivery. The gateway connection was down when a delivery attempt was made. If the maximum retry count has not been reached, reschedule the delivery.

C (Completed)

There are no outstanding messages to be sent for the task, and the gateway timeout period for receiving delivery reports has expired.

(tick)

I (Incomplete)

The gateway connection went down during the delivery of task messages. Not all messages could be sent to the gateway. Try to re-send the remaining messages later.

B (Busy)

Messages for this task are in the process of being sent to the gateway.

Typical task status transitions:

  • A successful task: Pending > Busy > Sent > Completed.
  • A task which experiences an error during delivery (for example the connection to the SMPP gateway is lost or timed out): Pending > Busy > Incomplete > Busy > Sent > Completed.

SMS_MESSAGE

STATUS_CODE

Explanation

Tool icon

S (Sent)

The message has been successfully sent to the gateway. We know nothing more about the message status at this stage.

F (Failed)

The gateway reported that the message could not be delivered. The mobile number may be invalid or unrouteable. See the SMSC_DELIVERY_STATUS_CODE for the error code returned by the gateway.

(error)

X (Expired)

The expiry time for the task containing this message passed without the message being delivered.

(error)

P (Pending)

The message is awaiting delivery to the gateway, for example because the task for this message originated on a server in a cluster which is not bound to the gateway.

D (Delivered)

The gateway reported that the message was successfully delivered.

(tick)

T (Timeout)

No delivery report was received for this message within the task delivery timeout period (i.e. the task has changed status to STATUS_TASK_COMPLETED).
The mobile number is valid but no delivery receipt was received for this message, thus it is not known
definitely whether the message was delivered or not. This could be a result of the mobile phone being switched off or not active on the network, or the network may not have sent back a delivery receipt.
STATUS_TIMEOUT messages may be changed to STATUS_DELIVERED should a delivery report arrive for them.

(tick)

A (Aborted)

The task for this message was aborted, and the message was therefore not sent.

(error)

E (Error)

An error occurred when we tried to delivery the message to the gateway: the gateway returned an error code and did not accept the message, or there was no response to the submission attempt, or the gateway was unexpectedly not available. See the FAIL_REASON field for the message for more detail on the cause.

(error)

Typical message status transitions:

  • Sent successfully with immediate delivery report: Pending > Sent > Delivered.
  • Sent successfully with very late delivery report: Pending > Sent > Timeout > Delivered.
  • Sent successfully to the gateway, but gateway could not deliver the message: Pending > Sent > Failed
  • Refused by gateway: Pending > Error
  • No labels