Parameters

The parameters below are the POST parameters that can be provided, in order to retrieve your account balance.

Please ensure these parameters are submitted in uppercase.

Parameter Required Type Possible/ Example Value(s)
USERNAME Yes String
 PASSWORD Yes String
 RECIPIENT No String  61435800957
 REFERENCE No String

NOTE: Either the ‘RECIPIENT’ OR the ‘REFERENCE’ parameters must be provided.

POST PARAMETERS DEFINITIONS

USERNAME

  • Type: string
  • Description: This is your Username for your SMS Central account.

PASSWORD

  • Type: string
  • Description: This is your Password for your SMS Central account.

RECIPIENT

  • Type: string
  • Description: This is the recipient value of the number you sent the message to. By providing a value in this parameter (as opposed to using the REFERENCE parameter) you will receive the status value for up to the 10 most recent messages (in the current month) that you have sent to that customer.
    Note, you can supply a comma separated list of values, of up to 10 mobile numbers, for the RECIPIENT parameter. This will return the status of (up to) the last 10 messages in the current month, for each of those recipient values.

REFERENCE

  • Type: string
  • Description: This is the unique reference value you provided when sending the original outbound message. This allows you to check the status for an individual message.
    Note, you can supply a comma separated list of values, of up to 100 values, for the REFERENCE parameter. This will return the status of all 100 messages matching to the unique reference values provided.

 

Response

After sending your HTTP POST with the required parameters to the API URL for checking the delivery status of your message, SMS Central will return a “HTTP/1.1 200 OK” HTTP status code in the header of the response to your HTTP POST and XML-formatted content providing the details of the status of the message(s).

If you are providing the ‘REFERENCE’ value, then a single XML <message> tag will be provided for the individual message matching that REFERENCE. If you provide a comma-separated list of (up to 100) REFERENCE values, a single ‘<message>’ block will be returned for each individual message matching each of the REFERENCE values provided.

If you are providing the ‘RECIPIENT’ value, then you will receive up to 10 <message> blocks, containing the 10 most recent messages sent to that recipient within the current month. If you provide a comma-separated list of (up to 10) RECIEPIENT values, you will be returned up to 10 <message> blocks for each of the RECIPIENT values, showing the 10 most recent messages to those recipient values within the current month.

The XML Response will be formatted as per the following tags and XML structure. The following contains example values:

<messages>
      <message>
            <reference>ABC123</reference>
            <datestamp>2015-01-02 18:17:59</datestamp>
            <recipient>61400000000</recipient>
            <status>DELIVRD</status>
            <statusdescription>0004: Delivered to mobile service</statusdescription>
      </message>
      <message>
            <reference>ABC456</reference>
            <datestamp>2015-01-02 21:28:44</datestamp>
            <recipient>61400000001</recipient>
            <status>DELIVRD</status>
            <statusdescription>0004: Delivered to mobile service</statusdescription>
      </message>
</messages>