...
| Блок кода | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"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 | Да | Текст сообщения. Для WhatsApp указываем любой текст, так как текст будет браться из шаблона |
| | | provider | String | Да |
Провайдер для отправки сообщения. Всегда указываем TWIN |
| callbackUrl | String | Нет | Адрес для отправки вебхука по статусу отправленного сообщения (только сообщения рассылки, а не все сообщения чат-сессии) |
| callbackData | String | Нет | Дополнительные данные, которые нужно прикладывать к вебхуку |
| sendAt | String | Нет | Дата и время старта рассылки |
| allowedTimeRanges | Array[Array[String]] | Нет | Массив разрешенных периодов времени для отправки (часовой пояс определяет по часовому поясу, где зарегистрирован номер абонента) |
| | destinations | Array[Object] | Да | Массив "клиентов" для отправки сообщений |
| | | variables | Array[Dictionary] | Нет | Массив дополнительных переменных, которые нужно отправить в чат-сессию |
| | | phone | String | Да | Номер телефона клиента |
| | | messengerUserId | String | Да | Идентификатор клиента. Для WhatsApp всегда равен номеру телефона |
| | | externalId | String | Нет | Собственный идентификатор для удобства определения чат-сессии/чат-сессий с клиентом |
| Блок кода | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
[
{
"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": "CHAT",
"error": null
}
] |
Описание полей ответа:
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
Array[Object] | Да | массив отправленных сообщений | |
| id | String | Да | Идентификатор сообщения |
| bulkId | String | Да | Общий идентификатор всех сообщений из рассылки |
| groupId | String | Да | Внутренний идентификатор |
| flowId | String | Да | Внутренний идентификатор |
| status | String | Да | Статус сообщения |
| channel | String | Да | Канал отправки |
| error | Object | Да | Объект ошибки. Равен null, если ошибки нет |
| | message | String | Нет | Сообщение об ошибке. Отсутствует, если ошибки нет. |