Parameters

When forwarding delivery receipts (DLRs) to the URL you have specified with a HTTP GET,  the following parameters will be provided:

Parameter Type Possible/ Example Value(s)
USER_NAME String
 PASSWORD String
 ORIGINATOR String  Mobile number (in international format): eg 61435748922
 RECIPIENT String
 PROVIDER String  “telstra”, “optus”, “vodafone”, “virgin”, “hutc3g”
 MESSAGE_TEXT String
 ID String
 REFERENCE String
 RESULT Integer  See Success & Error Response Codes
UDH String Example: 0500038A0302 (see definition below)
STATUS String  DELIVRD, BUFFRED, FAILED
STATUSDESCRIPTION String  If failure, a textual description of the reason for failure.

HTTP GET Parameters Definitions

USER_NAME

  • Type: string
  • Description: This is the Username you set for the URL in Rules & Triggers i.e. the username required for Basic Authentication.

PASSWORD

  • Type: string
  • Description: This is the password you set for the URL in Rules & Triggers i.e. the password required for Basic Authentication.

ORIGINATOR

  • Type: string
  • Description: This is the phone number, in international format, of the originator or sender of the message.  This is the number you sent the message ‘from’.

*In international format, an example of an Australian originator value is:

61435800957

RECIPIENT

  • Type: string
  • Description: This is the phone number, in international format, of the recipient of the message. This is the number you send the message ‘to’.
    *In international format, an example of an Australian recipient value is:

    61435800957

PROVIDER

  • Type: string
  • Description: This is a text representation identifying the Mobile Network Operator (carrier). This value will be ‘default’ (string, without single quotes) for standard SMS messages.

MESSAGE_TEXT

  • Type: string
  • Description: This is the text of the message you send to the recipient.

ID

  • Type: string
  • Description: This is an internal reference ID for this message, provided by SMS Central. This is used for internal SMS Central tracking and you may quote this ID in support requests.

REFERENCE

  • Type: string
  • Description: This is the (optional) unique REFERENCE value for the message that you provided when sending an SMS. This allows you to match the delivery receipt to the message you sent.

RESULT

  • Type: string
  • Description: This is a numerical result of the delivery status, providing a final confirmation value of the delivery or failure of the message. Please see Success and Error Response Codes  for possible values.

UDH

  • Type: string
  • Description: This is the standard User Data Header used in GSM to identify different parts of a multipart message. The value consists of 6 octets of hex digits.
    An example value is: 0500038A0302
    – The first 3 octets will always be “050003”.
    – The next octet (“8A” in the example) identifies the group. However, since we will pass your reference back to you in the delivery receipt, this octet will probably be useful for double checking only.
    – The next octet (“03″ in the example) specifies the total number of parts in the group.
    – The last octet (“02″ in the example) specifies the particular part of this message/delivery receipt. In this case, the delivery receipt would be for the second part of a 3-part message.In order to check that the full message is delivered, you will need to look at the last 2 octets to check how many parts a message has, and check that you received a positive delivery for each part.

STATUS

  • Type: string
  • Description: This value indicates the delivery status of the message and may include values such as:
    DELIVERD – this indicates the message, or this part of the message has been delivered
    BUFFRED – this indicates the message has been sent to the carrier and is currently undelivered by the carrier with a temporary failure result (i.e phone may be out of range)
    FAILED – this indicates that the carrier was unable to deliver the message

STATUSDESCRIPTION

  • Type: string
  • Description: This field provides a verbose string representation of the reason for the message failure. You may see values such as:
    “0001: Phone related” – Indicates the delivery failure is a handset issue
    “0008: Message expired within the carrier and failure reason unknown”
    “0002: Deliverer related: message within carrier”
    “0004: Delivered to mobile service” (when the errorcode is DELIVRD)