Requesting a status update for existing SMS messages

Requests a status update for existing AnyNet Messaging Service messages when the following conditions are met:

  • The authenticated user has access rights to send an SMS
  • If an optional IP address Allowlist exists, the source device is listed on it

  • The SIM is not barred from receiving SMS messages

    Enabling or disabling SMS Messages is linked to the SIM package, which is outside the scope of the SMS API.

Authentication

  • SMS API credentials

Request application/x-www-form-urlencoded

Schema

POST parameters Description Required?

username

 The Eseye-assigned SMS API username
password The Eseye-assigned SMS API password
message_id A user-generated unique message identifier for tracking responses.

Example

Copy
HTTP POST request
POST http://messaging.eseye.com/mtstatusapi/index/post

Example POST parameters for this request:

  • username – UserName
  • password – UserPassword
  • message_id – 2554f63f1e5d6ac862fa2b6883edb5b1

Response application/xml

Schema

XML Parameters Description
statusResponse

The XML object, containing details about the request status.
status

The status is either:

blocked – Message blocked by rule

sent – Message queued on network

error – An error occurred. For more information, see Troubleshooting errors: SMS API.

queued – Not delivered yet, message awaiting routing

delivered – Successful delivery

mgmt – Message queued on network
description Contains a more detailed description of the response.

Example

<statusResponse>

<status>delivered</status>

<description>Message delivered</description>

</statusResponse>

Where to next?

Related resources