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