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)

Параметри запиту

idnumberобов'язковий Унікальний ідентифікатор повідомлення в системі клієнта

msg_idnumber Ідентифікатор повідомлення, присвоєний шлюзом

typestringrequired Тип запиту

statusstring Статус повідомлення

datetimestring Дата і час отримання відповіді Формат: YYYYY-MM-DDThh:mm:ss±hh:mm

replieslist[object] Список відповідей на повідомлення ⚠️ Присутній тільки у Viber 2 Way datetimestring Дата і час отримання відповіді Формат: YYYYY-MM-DDThh:mm:ss±hh:mm messagestring Текст повідомлення mediaobject Об'єкт, що містить інформацію про медіафайл, прикріплений до повідомлення urlstring Посилання на медіафайл filenamestring Ім'я медіафайлу filesizenumber Розмір медіафайлу

Приклад запиту

Default

{
    "id": 100500,
    "msg_id": 123456789,
    "type": "viber",
    "status": "READ",
    "datetime": "2024-01-31T12:34:00+02:00"
}

Viber 2 Way

{
    "id": 100500,
    "msg_id": 123456789,
    "type": "viber",
    "status": "READ",
    "datetime": "2024-01-31T12:34:00+02:00",
    "replies": [
        {
            "datetime": "2024-01-31T12:34:00+02:00",
            "message": "Please wait"
        },
        {
            "datetime": "2024-01-31T12:34:01+02:00",
            "media": {
                "url": "https://url.com/home/vibermedia/",
                "filename": "invoice.pdf",
                "filesize": 67983
            }
        },
        {
            "datetime": "2024-01-31T12:34:02+02:00",
            "message": "Correct invoice",
            "media": {
                "url": "https://url.com/home/vibermedia/",
                "filename": "invoice.pdf",
                "filesize": 68934
            }
        }
    ]
}

Параметри відповіді

У відповіді буде отримано код 200.

Приклад відповіді

Успішний

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