Вы просматриваете старую версию данной страницы. Смотрите текущую версию.

Сравнить с текущим просмотр истории страницы

« Предыдущий Версия 3 Следующий »

Метод: POST

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

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

Тело запроса в формате Json
{
    "messages": [
        {
            "channels": {
                "chat": {
                    "chatId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
                    "botId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
                    "messengerType": "WHATSAPP",
                    "chatSessionName": "Название сессии",
                    "text": "Текст сообщения",
                    "provider": "TWIN"
                }
            },
            "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",
                    "messengerUserId": "74992868344",
                    "externalId": "qwerty12345"
                }
            ]
        }
    ]
} 

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

Поле

Тип

Обязательно

Описание

messages

Array[Object]

Да

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

|    channels

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

|    |    chat

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

|    |    |    chatId

StringДаИдентификатор чата (к которому подключен WhatsApp)

|    |    |    botId

StringДаИдентификатора бота (в котором настроен шаблон для WhatsApp)

|    |    |    messengerType

StringДаТип мессенджера для отправки: Для WhatsApp всегда указываем "WHATSAPP"

|    |    |    chatSessionName

StringНетИмя сессии для удобства ее определения при получении статистики

|    |    |    text

StringДа

Текст сообщения. 


|    |    |    provider

StringДаДля WhatsApp указываем любой текст, так как текст будет браться из шаблона

|    callbackUrl

StringНетАдрес для отправки вебхука по статусу отправленного сообщения (только сообщения рассылки, а не все сообщения чат-сессии)

|    callbackData

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

|    sendAt

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

|    allowedTimeRanges

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

Идентификатор клиента. 

Для WhatsApp всегда равен номеру телефона

|    |    externalIdStringНетСобственный идентификатор для удобства определения чат-сессии/чат-сессий с клиентом


  • Нет меток