Метод: POST

Authorization: Bearer Token (Метод для получения токена по логину и паролю)

URL: https://notify.twin24.ai/api/v1/messages

Тело запроса в формате Json
{
    "messages": [
        {
            "channels": {
                "sms": {
                    "text": "Привет, name! Поздравляю с Днем Рождения! age - это крутой возраст!",
                    "from": "TwinService",
                    "provider": "TWIN",
                    "validityPeriod": 60,
                    "required": true
                }
            },
            "useShortLinks": true,
            "callbackUrl": "http://example.com",
            "callbackData": "123",
            "sendAt": "2023-12-31T12:00:00+00:00",
            "allowedTimeRanges": [
                [
                    "00:00:00",
                    "05:00:00"
                ],
                [
                    "08:00:00",
                    "12:00:00"
                ],
                [
                    "19:30:00",
                    "23:55:00"
                ]
            ],
            "destinations": [
                {
                    "variables": {
                        "name": "Иван",
                        "age": "23"
                    },
                    "phone": "74992868344"
                }
            ]
        }
    ]
} 

Описание полей метода:

Поле

Тип

Обязательно

Описание

messages

Array[Object]

Да

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

|    channels

ObjectДаИспользуемые каналы отправки

|    |    sms

ObjectДаОбъект канала "sms" для отправки

|    |    |    text

StringДа

Текст сообщения, которое нужно отправить. 

Если нужно вложить переменные в текст, то использовать их нужно без фигурных скобок, как в примере. Сами переменные будут взяты из поля variables (описано ниже)

|    |    |    from

StringДа

Имя отправителя. 

Подробнее о регистрации имени отправителя в отдельной статье

|    |    |    provider

StringДаПровайдер для отправки sms сообщений

|    |    |    validityPeriod

IntНетДлительность доставки сообщения. В качестве значения данного параметра используется целое число в диапазоне от 1 - 2880 (макс. 48 часов). Если сообщение за это время не будет доставлено, то сообщение получит статус Expired.

|    |    |    required

BoolНет

Обязательность канала отправки (актуально для каскадных рассылк в разные каналы)

|    useShortLinks

BoolНет

Если true, то все ссылки в сообщении будут заменены на короткие ссылки

|    callbackUrl

StringНетАдрес для отправки вебхука по статусу отправленного сообщения

|    callbackData

StringНетДополнительные данные, которые нужно прикладывать к вебхуку

|    sendAt

StringНетДата и время старта рассылки

|    allowedTimeRanges

Array[Array[String]]НетМассив разрешенных периодов времени для отправки (часовой пояс определяет по часовому поясу, где зарегистрирован номер абонента)
|    destinationsArray[Object]ДаМассив "клиентов" для отправки сообщений
|    |    variablesArray[Dictionary]НетМассив дополнительных переменных, которые нужно отправить в чат-сессию
|    |    phoneStringДаНомер телефона клиента


Ответ в формате JSON
[
    {
        "id": "09f0591d-7e62-4311-8d92-d9a287e55118",
        "bulkId": "e27ebd69-046f-42fc-98e0-9df074dbd12d",
        "groupId": "e9319d2a-866f-41a4-bca6-b170a2e4eeb4",
        "flowId": "6e0fef0e-2349-400b-91e5-c636a8925718",
        "status": "DELAYED",
        "channel": "SMS",
        "error": null
    }
]

Описание полей ответа:

Поле

Тип

Обязательно

Описание


Array[Object]

Да

массив отправленных сообщений

|    id

String

Да

Идентификатор сообщения

|    bulkId

String

Да

Общий идентификатор всех сообщений из рассылки

|    groupId

String

Да

Внутренний идентификатор

|    flowId

String

Да

Внутренний идентификатор

|    status

String

Да

Статус сообщения

|    channel

String

Да

Канал отправки

|    error

Object

Да

Объект ошибки. Равен null, если ошибки нет

|    |   message

String

Нет

Сообщение об ошибке. Отсутствует, если ошибки нет. 


  • Нет меток