Відправка RCS з переотправкою по SMS та Viber

Приклад запиту для відправки RCS-повідомлення з текстом, зображенням, кнопкою та переотправкою по SMS та Viber у разі неможливості доставки.

URI: /api/json.php

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

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

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

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

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

datalist[object]обов'язковий Список об'єктів з параметрами запиту typestringобов'язковий Тип запиту idnumberобов'язковий Унікальний ідентифікатор повідомлення в системі клієнта phonenumberобов'язковий Номер телефону одержувача повідомлення sms_signaturestringобов'язковий Підпис у повідомленні sms_messagestringобов'язковий Текст повідомлення для відправки через SMS rcs_signaturestringобов'язковий Підпис у повідомленні rcs_messagestringобов'язковий Текст повідомлення для відправки через SMS rcs_imagestringобов'язковий Посилання на зображення, яке буде надіслано в повідомленні rcs_linkstringобов'язковий Посилання, за яким буде здійснено перехід після натискання кнопки rcs_buttonstringобов'язковий Підпис, який буде відображатися на кнопці viber_typestringобов'язковий Тип повідомлення Viber viber_signaturestringобов'язковий Підпис у повідомленні viber_messagestringобов'язковий Текст повідомлення що буде надіслано через Viber viber_imagestringобов'язковий Посилання на зображення, яке буде надіслано в повідомленні viber_linkstringобов'язковий Посилання, за яким буде здійснено перехід після натискання кнопки viber_buttonstringобов'язковий Підпис, який буде відображатися на кнопці rcs_lifetimenumber Час життя RCS-повідомлення в секундах Мінімальне значення: 60 секунд За замовчуванням: 2 дні (172800 секунд) short_linkboolean Короткі та відстежувані посилання hookstring URL-адреса скрипта, куди буде відправлено статус доставки повідомлення

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

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "rcs+viber+sms",
            "id": 100500,
            "phone": 380971234567,
            "sms_signature": "SMSTest",
            "sms_message": "Текст повідомлення для відправки через SMS",
            "rcs_signature": "RCSTest",
            "rcs_message": "Message text to be sent via RCS",
            "rcs_image": "https://url.com/storage/images/image.png",
            "rcs_link": "https://redirect.url",
            "rcs_button": "Button caption",
            "viber_type": "text+image+link",
            "viber_signature": "ViberTest",
            "viber_message": "Message text to send via Viber",
            "viber_image": "https://url.com/storage/images/image.png",
            "viber_link": "https://redirect.url",
            "viber_button": "Button caption",
            "rcs_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
            }
        }
    ]
}