Отправка RCS

Пример запроса для отправки RCS-сообщения с текстом, изображением и кнопкой, при нажатии на которую будет осуществлен переход по указанной ссылке.

URI: /api/json.php

Все запросы к API отправляются в формате JSON с помощью метода POST.

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

В запросах обязательно должен быть заголовок Content-Type: application/json, иначе запрос будет считаться некорректным даже при валидном JSON в нем

Параметры запроса

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

datalist[object]обязательный Список объектов с параметрами запроса typestringобязательный Тип запроса idnumberобязательный Уникальный идентификатор сообщения в системе клиента phonenumberобязательный Номер телефона получателя сообщения rcs_signaturestringобязательный Подпись в сообщении rcs_messagestringобязательный Текст сообщения для отправки по SMS rcs_imagestringобязательный Ссылка на изображение, которое будет отправлено в сообщении rcs_linkstringобязательный Ссылка, по которой будет осуществлен переход после нажатия кнопки rcs_buttonstringобязательный Текст, который будет отображаться на кнопке rcs_lifetimenumber Время жизни RCS-сообщения в секундах Мін. значение: 60 секунд По умолчанию: 2 дня (172800 секунд) short_linkboolean Короткие и отслеживаемые ссылки hookstring URL-адреса скрипта, куда будет отправлен статус доставки сообщения

Пример запроса

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "rcs",
            "id": 100500,
            "phone": 380971234567,
            "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",
            "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
            }
        }
    ]
}