Receiving a Delivery Report

Receiving a Delivery Report

Delivery reports are sent to your callback URL when we receive them from the network operators. They are intended to notify you of the delivery status of a message — for example, we will send you a DELIVERED (or equivalent) status when we know that the SMS has successfully reached the phone.

The following HTTP GET parameters will be sent to your callback URL when we receive a delivery report:

Variable Type Contents

sms

String

A long string translated from SMPP that contains the delivery status of the message. For example:

id:5918351498722606 sub:001 dlvrd:001 submit date:1410311037 done date:1410311038 stat:DELIVRD err:000 text:New HTTP Test TxtN
		

Within this string there are several important fields that you should use:

  • id — The identifier of the message that was sent. This value would have been returned to you after a successful message submission. See Sending a Message for more details.
  • submit date — The date at which the message was submitted to the network operator. This is in the UNIX timestamp format.
  • done date — The date at which the message was completed by the network operator. This is in the UNIX timestamp format.
  • stat — The status of the message represented by a string according to the list below.
  • err — The specific error code if provided this will be 000 if there is no error.
  • text — The inital message sent to the MSISDN.

msisdn

String

The MSISDN of the destination address

src

String

The source address of the message

dcs

Integer

The data coding scheme used. This can be one of the following:

  • 0 — Normal SMS
  • 8 — Unicode SMS
  • 240/244 — Flash SMS
  • 245 — vCard

type

String

The type of message that was sent. This can be one of the following:

  • 0 — Normal SMS
  • u — Unicode SMS
  • f — Flash SMS
  • b — Binary SMS

Disposition States

The stat value determines the status of the sent message. Typically it can be one of the following:

Status Description Final State?
DELIVERED The message was successfully delivered
DELIVRD The message was successfully delivered
ACK The message has been acknowledged for delivery
ACKED The message has been acknowledged for delivery
ACKNOWLEDGED The message has been acknowledged for delivery
ACCEPTD The message has been accepted for delivery
REJECT or REJCTED The message was rejected
REJECTED The message was rejected
REJECTD The message was rejected
UNDELIV or UNDELIVE The message could not be delivered
UNDELIVER The message could not be delivered
UNDELIVERED The message could not be delivered
EXPIRD The message validity has expired
EXPIRED The message validity has expired
DELETED The message was deleted before delivery
DELETE The message was deleted before delivery
OPSDELETED The message was deleted by the network before delivery
ABANDONED Delivery of the SMS was abandoned
RETRY The message could not be delivered but is being retried
RETRYNG The message could not be delivered but is being retried
RETRYING The message could not be delivered but is being retried
CREDIT ERROR The MSISDN did not have sufficient credit to receive the message
STORE BUSY The store was busy
INTERFACE BUSY The interface was busy
OTHER ERROR An unspecified error occurred
FACILITY NOT SUPPORTED The type of message was not supported by the receiving network of handset
DATABASE FULL The network database is full so the message could not be accepted
SME BUSY The SME was too busy to accept the message
NETWORK FAILURE There was a failure at the network level
DESTINATION NOT KNOWN The destination address was not recognised
UNIDENTIFIED SUBSCRIBER The destination address was unknown
CALL BARRED The type of message was barred by the receiving MSISDN
USER CALL BARRED The type of message was barred by the receiving MSISDN
MEMORY CAPACITY EXCEEDED The capacity for messages was exceeded at the network layer
ABSENT IMSI DETACHED The receiving MSISDN was absent
SMS NOT PROVISIONED The SMS was not provisioned by the network
ERROR IN MS There was an unspecified error with the MSISDN
ABSENT IMSI DETACHED GPRS The receiving MSISDN was absent
ABSENT DEREGISTERED IN HLR The receiving MSISDN was absent in the Home Location Register
ABSENT MS PURGED The receiving MSISDN was absent so the message was purged
ABSENT PAGE FAIL The receiving MSISDN was absent
ABSENT ROAMING RESTRICTION The receiving MSISDN was absent
CALL BARRED (NO CREDIT) The MSISDN did not have sufficient credit to receive the message
CALL BARRED (NO ACCESS TIME) The MSISDN did not have sufficient credit to receive the message
SYSTEM FAILURE There was an unspecified system failure during the send
UNEXPECTED DATA VALUE There was an unexpected data value set in the submission
TRANSMISSION ERROR There was an error when sending the message to the network
DEFERRED DELIVERY The delivery of the SMS has been deferred
NOCRED The MSISDN did not have sufficient credit to receive the message
FAILED The message delivery failed
BUFFRED The message has been buffered for delivery
UNDELIVERABLE The message was undeliverable
PORTED OUT MSISDN The MSISDN is no longer served by the network
UNKNOWN An unknown error occurred during the send

Next: Using SMPP