The get_status call is used to get a status update for a batch of MO SMSs.

URL: https://tms.flashmedia.co.za/api/sms/get_status

HTTP Method: GET

Input Parameters

batch_id

The ID of the batch for which you are requesting the status. This parameter is returned when submitting a request to send.

Data Returned

reports

Contains a list of update reports for each destination in the batch that the message was sent to.

status

The status of the message. The status can be one of the following:

• ENROUTE - message is enroute to its destination (not in a finalised state yet).
• DELIVRD - message is delivered to destination.
• EXPIRED - message validity period has expired.
• DELETED - message has been deleted.
• UNDELIV - message is undeliverable.
• ACCEPTD - message was read by the network on behalf of the mobile user.
• UNKNOWN - message is in an invalid state.
• REJECTD - message was rejected by the network.

msisdn

The destination (mobile number) that the message was sent to.

network_id

The ID of the mobile network that the message was sent to.

tms_session_id

The unique ID of the message as assigned by TMS3.

delivery_date

The date the message was finalised, i.e. delivered, rejected etc.

batch_id

The batch that the message belongs to.

Example API call using cURL

JSON

curl -X GET https://tms.flashmedia.co.za/api/sms/get_status?batch_id=1108171120088969084 \
-u 'username:password' -H 'Accept: application/json'

XML

curl -X GET https://tms.flashmedia.co.za/api/sms/get_status?batch_id=1108171120088969084 \
-u 'username:password' -H 'Accept: application/xml'

Example Successful Response

JSON

{
  "reports":
    [
      {
        "batch_id":1108171120088969084,
        "network_id":1,
        "status":"DELIVRD",
        "msisdn":"27820000222",
        "tms_session_id":2016108042,
        "delivery_date":"2011-08-17 11:20:08.0"
      },
      {
        "batch_id":1108171120088969084,
        "network_id":1,
        "status":"DELIVRD",
        "msisdn":"27820000555",
        "tms_session_id":411899220,
        "delivery_date":"2011-08-17 11:20:08.0"
      },
      {
        "batch_id":1108171120088969084,
        "network_id":3,
        "status":"DELIVRD",
        "msisdn":"27840000111",
        "tms_session_id":1200967309,
        "delivery_date":"2011-08-17 11:20:08.0"
      }
    ]
}

XML

<sms_get_status>
  <reports>
    <delivery_report>
      <msisdn>27820000222</msisdn>
      <delivery_date>110817112008</delivery_date>
      <network_id>1</network_id>
      <status>DELIVRD</status>
      <batch_id>1108171120088969084</batch_id>
      <tms_session_id>2016108042</tms_session_id>
    </delivery_report>
    <delivery_report>
      <msisdn>27820000555</msisdn>
      <delivery_date>110817112008</delivery_date>
      <network_id>1</network_id>
      <status>DELIVRD</status>
      <batch_id>1108171120088969084</batch_id>
      <tms_session_id>411899220</tms_session_id>
    </delivery_report>
    <delivery_report>
      <msisdn>27840000111</msisdn>
      <delivery_date>110817112008</delivery_date>
      <network_id>3</network_id>
      <status>DELIVRD</status>
      <batch_id>1108171120088969084</batch_id>
      <tms_session_id>1200967309</tms_session_id>
    </delivery_report>
  </reports>
</sms_get_status>