Отправка 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обязательный Carousel slide caption to be sent via 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
            }
        }
    ]
}