Многоканальная доставка сообщений

Данный 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": "ru-RU",
                    "name": "ru-RU-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
            }
        }
    ]
}