POST request

POST request to get message status

POST http://lk.mysmpp.ru/xml/state.php

Headers

NameTypeDescription

Content-type

Sting

text/xml; charset=utf-8;

Request Body

NameTypeDescription

login.value*

Sting

Your login in the system

token.value*

Sting

You can use a secret key instead of login and password. To obtain it, please contact your manager

password.value*

Sting

Your password in the system

get_state.id_sms*

Int

The SMS message number received in the response XML document during the SMS message sending process.

<?xml version="1.0" encoding="utf-8" ?>
<response>
     <state id_sms="SMS ID in the system to check the status" time="2011-01-01 12:57:46" sms="Status">Status</state>
     <state id_sms="SMS ID in the system to check the status" time="2011-01-01 12:57:46" sms="Status" viber="Status">Status</state>
     <state id_sms="SMS ID in the system to check the status" time="2011-01-01 12:57:46" viber="Status">Status</state>
</response>

Deciphering parameters in query responses

ParameterData typeDescription

state

String

Last message status:

  • "send" - message status not received. In this case, an empty time (time="") is transmitted

  • "not_deliver" - the message was not delivered. Final status (does not change with time)

  • "expired" - the subscriber was not in the network at the moments when the delivery attempt was made. Final status (does not change with time)

  • "deliver" - the message has been delivered.

  • "read" - the message has been read. Final status (does not change over time)

  • "partly_deliver" - the message was sent, but the status was not received.

state.id_sms

Int

XML document in the process of sending SMS message

state.time

String

Time of status change

state.sms, state.viber

String

Message status.

The name of the field depends on the type of the message to be sent and resent

error

String

The error text can take the following values:

  • Incorrect XML document format

  • Incorrect login or password

  • POST data is missing

Example XML request

<?xml version="1.0" encoding="utf-8" ?>
<request>
    <security>
        <login value="login" />
        <password value="password" />
    </security>
    <get_state>
        <id_sms>IDSMS in system to check status</id_sms>
        <id_sms>IDSMS in system to check status</id_sms>
        <id_sms>IDSMS in system to check status</id_sms>
        <id_sms>IDSMS in system to check status</id_sms>
    </get_state>
</request>

Last updated