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