Відправка Viber з текстом та каруселлю

Приклад запиту для відправки Viber-повідомлення з текстом та каруселлю на вказаний номер.

URI: /api/json.php

Усі запити до API надсилаються у форматі JSON за допомогою методу POST.

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

У запитах обов'язково має бути заголовок Content-Type: application/json, інакше запит буде вважатися некоректним навіть при валідному JSON у ньому.

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

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

datalist[object]обов'язковий Список об'єктів з параметрами запиту typestringобов'язковий Тип запиту idnumberобов'язковий Унікальний ідентифікатор повідомлення в системі клієнта phonenumberобов'язковий Номер телефону одержувача повідомлення viber_typestringобов'язковий Тип повідомлення Viber viber_signaturestringобов'язковий Підпис у повідомленні viber_messagestringобов'язковий Текст повідомлення що буде надіслано через Viber viber_carousellist[object]обов'язковий Список об'єктів з параметрами для слайдів каруселі (2-5 слайдів) captionstringобов'язковий Подпись слайда карусели, которая будет отправлена через Viber imagestringобов'язковий Посилання на зображення, яке буде надіслано в повідомленні urlstringобов'язковий Посилання, за яким буде здійснено перехід після натискання кнопки buttonstringобов'язковий Підпис, який буде відображатися на кнопці url2string Посилання, за яким буде здійснено перехід після натискання додаткової кнопки button2string Підпис, який буде відображатися на додатковій кнопці viber_lifetimenumber Час життя Viber-повідомлення в секундах Мін. значення: 60 секунд За замовчуванням: 2 дні (172800 секунд) short_linkboolean Короткі та відстежувані посилання hookstring URL-адреса скрипта, куди буде відправлено статус доставки повідомлення

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

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "viber",
            "id": 100500,
            "phone": 380971234567,
            "viber_type": "carousel",
            "viber_signature": "ViberTest",
            "viber_message": "Message text to send via Viber",
            "viber_carousel": [
                {
                    "caption": "Title 1",
                    "image": "https://url.com/storage/images/image1.png",
                    "url": "https://example.org",
                    "button": "Button caption"
                },
                {
                    "caption": "Title 2",
                    "image": "https://url.com/storage/images/image2.png",
                    "url": "https://example.org",
                    "button": "Button caption 2"
                }
            ],
            "viber_lifetime": 172800,
            "short_link": true,
            "hook": "https://example.org/webhook/url.php"
        }
    ]
}

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

successinteger Результат виконання запиту

errorstring Текст помилки, що повертається, якщо success=false

datalist[object] Список об'єктів з результатами виконання запиту successboolean Результат виконання запиту повернутий у пакеті даних errorstring Текст помилки, що повертається, якщо data.success=false dataobject Результат виконання запиту idnumber Унікальний ідентифікатор повідомлення в системі клієнта msg_idnumber Ідентифікатор повідомлення, присвоєний шлюзом datanumber Опис partsnumber Кількість повідомлень, використаних для надсилання вказаного тексту

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

Успішний

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

{
    "success": true,
    "data": [
        {
            "success": true,
            "data": {
                "id": 100500,
                "msg_id": 123456789,
                "data": 1,
                "parts": 1
            }
        }
    ]
}

Доступ заборонено

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

{
    "success": false,
    "error": "Access denied"
}

Помилка в Альфа-імені

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

{
    "success": true,
    "data": [
        {
            "success": false,
            "error": "Error in Alpha-name",
            "data": {
                "id": 100500
            }
        }
    ]
}