Webhook

Пример запроса сервера на адрес вебхука, передаваемый в параметре hook запроса для отправки сообщений.

URI: /api/json.php

Все запросы к API отправляются в формате JSON с помощью метода POST.

Параметры заголовков

В запросах обязательно должен быть заголовок Content-Type: application/json и X-Signature, иначе запрос будет считаться некорректным даже при валидном JSON в нем

X-Signature

Заголовок X-Signature передается путем конкатенации JSON строки и API ключа.
Пример: X-Signature: sha256(json_body + api_key)

Параметры запроса

authstringобязательный Ваш API-ключ, который можно получить в личном кабинете

datalist[object]обязательный Список объектов с параметрами запроса idnumberобязательный Уникальный идентификатор сообщения в системе клиента msg_idnumber Идентификатор сообщения, присвоенный шлюзом typestringrequired Тип запроса statusstring Статус сообщения datetimestring Дата и время получения ответа Формат: YYYYY-MM-DDThh:mm:ss±hh:mm

Пример запроса

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "id": 100500,
            "msg_id": 123456789,
            "type": "viber",
            "status": "READ",
            "datetime": "2024-01-31T12:34:00+02:00"
        }
    ]
}

Параметры ответа

В ответе будет получен код 200.

Пример ответа

Успешный

HTTP Status Code: 200
Content Type: JSON application/json