Webhook

It is necessary to tell the manager the address of your server, which will receive SMS statuses

Method of sending XML document: POST

For example, in phpXML, the document will be accessible via a variable$GLOBALS['HTTP_RAW_POST_DATA']

The system sends an XML document to the client server with the following content:

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

Parameter decoding

Parameter
Data type
Description

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

SMS message number received in the response 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

Returned client server response in an XML document

If the client server does not transmit id_sms, the status will be considered as not received by the client. In this case 5 attempts will be made to deliver the status.

<?xml version="1.0" encoding="utf-8" ?>
<response>
     <id_sms>3234</id_sms>
     <id_sms>3235</id_sms>
</response>

Last updated