...
| Блок кода | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"messages": [
{
"channels": {
"chat": {
"chatId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
"botId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
"messengerType": "WHATSAPP",
"chatSessionName": "Название сессии",
"provider": "TWIN",
"text": "Текст сообщения"
}
},
"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"
},
"messengerUserId": "74992868344",
"phone": "74992868344",
"clientId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
"flowId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
}
]
}
]
} |
Описание полей метода:
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
messages | Array[Object] | Да | Массив сообщений для отправки |
| channels | Object | Да | Используемые каналы отправки |
| | chat | Object | Да | Объект канала "чат" для отправки |
| | | chatId | String | Да | Идентификатор чата |
| , из которого будет использоваться интеграция с мессенджером | |||
| | | botId | String | Да | Идентификатора бота |
| , который будет запущен для рассылки | |||
| | | messengerType | String | Да | Тип мессенджера для отправки |
. Возможные значения: WHATSAPP, VIBER, TELEGRAM, VKONTAKTE, FACEBOOK1, SKYPE, SLACK, YANDEX, ALICE, THREADS | |||
| | | chatSessionName | String | Нет | Имя сессии для удобства ее определения при получении статистики |
| | | provider | String | Да | Провайдер для отправки сообщения. Всегда указываем TWIN |
| | | text | String | Нет | Текст сообщения стартового сообщения "от клиента". Если в чате стоит "отвечать на первое сообщение пользователя" и сценарий настроен соответствующем образом, то это сообщение поступит боту на вход. Иначе никак не влияет на работу бота и может использоваться как дополнительное поле для идентификации. |
| callbackUrl | String | Нет | Адрес для отправки вебхука по статусу отправленного сообщения (только сообщения рассылки, а не все сообщения чат-сессии) |
| callbackData | String | Нет | Дополнительные данные, которые нужно прикладывать к вебхуку |
| sendAt | String | Нет | Дата и время старта рассылки |
| allowedTimeRanges | Array[Array[String]] | Нет | Массив разрешенных периодов времени для отправки (часовой пояс определяет по часовому поясу, где зарегистрирован номер абонента) |
| | destinations | Array[Object] | Да | Массив "клиентов" для отправки сообщений |
| | | variables | Array[Dictionary] | Нет | Массив дополнительных переменных, которые нужно отправить в чат-сессию |
| | | messengerUserId | String | Да (если не указан phone или clientId) | Идентификатор клиента в мессенджере |
| | | phone | String | Да (если не указан messengerUserId или clientId) | Номер телефона клиента |
| | | clientId | String | Да (если не указан messengerUserId или phone) | Идентификатор клиента в Twin |
| | | flowId | String | Нет | Уникальный идентификатор кандидата рассылки (Указывается как UUID) |
| Блок кода | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
[
{
"id": "09f0591dbce7d22e-7e62dde6-43114427-8d92b391-d9a287e55118ebbdfda44de6",
"bulkId": "e27ebd69bce7d22e-046fdde6-42fc4427-98e0b391-9df074dbd12debbdfda44de6",
"groupId": "e9319d2abce7d22e-866fdde6-41a44427-bca6b391-b170a2e4eeb4ebbdfda44de6",
"flowId": "6e0fef0ebce7d22e-2349dde6-400b4427-91e5b391-c636a8925718ebbdfda44de6",
"status": "DELAYED",
"channel": "CHAT",
"error": null
}
] |
...