Багатоканальна доставка повідомлень

Даний API дозволяє здійснювати багатоканальну доставку повідомлень з можливістю вибору каналів та встановлення пріоритетів. Користувачі вказують бажані канали зв'язку та послідовність у параметрі конвеєра, включаючи такі опції, як голосові дзвінки, Telegram, Viber та SMS. Telegram можна використовувати тільки для доставки одноразового пароля (OTP), тоді як голосові дзвінки рекомендується використовувати тільки для OTP. SMS та Viber підходять як для OTP, так і для транзакційних повідомлень. Параметри кожного каналу, такі як зміст повідомлення, налаштування голосу або підпис, можна налаштувати, щоб адаптувати повідомлення до його мети та одержувачів.

URI: /api/json.php

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

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

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

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

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

datalist[object]обов'язковий Список об'єктів з параметрами запиту typestringобов'язковий Тип запиту pipelinelist[string]обов'язковий Послідовність використання каналів комунікації idnumberобов'язковий Унікальний ідентифікатор повідомлення в системі клієнта phonenumberобов'язковий Номер телефону одержувача повідомлення voiceobjectобов'язковий Параметри голосового повідомлення messagestringобов'язковий Текст повідомлення, що буде озвучено voiceobjectобов'язковий Параметри голосу genderstringобов'язковий Тип голосу (чоловічий або жіночий) languagestringобов'язковий Мова озвучення namestringобов'язковий Назва мовної моделі dtmfbooleanобов'язковий Ознака використання тонального набору (DTMF) telegramobjectобов'язковий Параметри Telegram-повідомлення messagestringобов'язковий Текст повідомлення для відправки в Telegram viberobjectобов'язковий Параметри Viber повідомлення typestringобов'язковий Тип повідомлення Viber signaturestringобов'язковий Підпис у повідомленні messagestringобов'язковий Текст повідомлення що буде надіслано через Viber whatsappobjectобов'язковий Параметри WhatsApp повідомлення signaturestringобов'язковий Підпис у повідомленні messagestringобов'язковий Текст повідомлення що буде надіслано через WhatsApp smsobjectобов'язковий Параметри SMS-повідомлення signaturestringобов'язковий Підпис у повідомленні messagestringобов'язковий Текст повідомлення для відправки через SMS hookstring URL-адреса скрипта, куди буде відправлено статус доставки повідомлення

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

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "pipeline",
            "pipeline": [
                "voice",
                "telegram",
                "viber",
                "rcs",
                "sms"
            ],
            "id": 100500,
            "phone": 380971234567,
            "voice": {
                "message": "Your code is 100500",
                "voice": {
                    "gender": "female",
                    "language": "uk-UA",
                    "name": "uk-UA-Standard-A"
                },
                "dtmf": false
            },
            "telegram": {
                "message": "100500"
            },
            "viber": {
                "type": "text",
                "signature": "SenderID",
                "message": "Your code is 100500"
            },
            "whatsapp": {
                "signature": "SenderID",
                "message": "Your code is 1234"
            },
            "rcs": {
                "signature": "SenderID",
                "message": "Your code is 1234"
            },
            "sms": {
                "signature": "SenderID",
                "message": "Your code is 100500"
            },
            "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
            }
        }
    ]
}