Webhook

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

A method for sending a JSON document: POST

For example, in php, a JSON document would be accessed via the function file_get_contents("php://input") or a variable $GLOBALS['HTTP_RAW_POST_DATA']

The system sends a JSON document to the client server with the following content:

[
    {
        "id_sms": "SMS ID in the system to check the status",
        "time": "2011-01-01 12:57:46",
        "state": "Status"
        },
    {
        "id_sms": "SMS ID in the system to check the status",
        "time": "2011-01-01 12:57:46",
        "state": "Status"
    }
]

Parameter decoding

Parameter
Data type
Description

id_sms

Int

SMS message number received in the response JSON-document in the process of sending SMS message

time

String

Time of status change

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 receive

Returned client server response in JSON 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.

[
    {
        "id_sms":3234
    },
    {
        "id_sms":3235
    }
]

Last updated