",\
"url": ""\
},\
{\
"text": "",\
"buttonType": "",\
"phone": ""\
}\
]\
}\
]\
}\
}\
}
2. Необходимо прописывать данные согласованного шаблона рассылки, в противном случае адресат не получит рассылку (подробнее: Notification fail).
## Запуск рассылки
После того, как Канал Проекта создан, шаблон рассылки создан и согласован, а Слот Notification настроен, можно запускать рассылку. Для этого необходимо отправит запрос на рассылку.
### Формат запроса на рассылку
1. Запрос на рассылку должен обязательно включать идентификатор Собеседника в конечном канале на первом уровне JSON-а, случае c WhatsApp, это номер телефона. По этому идентификатору Платформа вычислит Чат или в случае, если он не существует, создаст новый Чат для отправки запроса. Название ключа зависит от Конечный канал.
2. 1. Формат идентификатора:
2. 1. поле типа “текст”;
2. От 10 до 18 цифр (от 11 до 19 с учетом +);
3. Допускается знак + в начале.
3. Запрос на рассылку может быть срочным или несрочным (параметр "is\_urgent"):
4. 1. значение true — для срочного Запрос на рассылку — выполняется незамедлительно и прерывает Активный диалог.
2. значение false — для несрочного Запрос на рассылку — выполняется после закрытия Диалога.
3. если ключ is\_urgent не найден, используется значение по умолчанию false.
5. Запрос на рассылку должен быть POST-запросом с валидным телом JSON и заголовком "Content-Type": "application/json"
6. Лимит на запросы на рассылку по умолчанию — 20 запросов в секунду на Компания. Лимит можно изменить через техподдержку.
7. Пример запроса на рассылку:\
POST <[https://admin.chatme.ai/api/notification/42282::0a04b116e59032ef014d649602cc0b54/chat'>\\](https://admin.chatme.ai/api/notification/42282::0a04b116e59032ef014d649602cc0b54/chat'>\\)
headers: {"Content-Type": "application/json"}\
body: {\
"phone\_number": "79291642944",\
"is\_urgent": true\
}
## Работа слота
Работа слота начинается с момента получения Платформа Запрос на рассылку из внешней системы.
### 1. Обработка входящего запроса на рассылку
В процессе обработки входящего запроса на рассылку выполняется ряд операций. По итогу выполнения операций вы можете получить один из указанных в таблице статусов:
| Ответ, полученный на запроса на рассылку | Расшифровка ответа |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| HTTP status: 429 | Превышение Лимит на запросы на рассылку для Компания |
| HTTP status: 405 | Запрос на рассылку не с POST-методом |
| HTTP status: 400 | - в Запрос на рассылку нет заголовка content-type: application/json
- невалидный JSON в теле Запрос на рассылку
|
| HTTP status: 404 | Не найдена Компания, связанная с Идентификатор рассылки (он содержится в вебхуке в поле Chatbot webhook) |
| HTTP status: 400 invalid
BODY:
“status”: “Recipient ID not found or invalid.”
| идентификатор Собеседника не был найден или он невалидный |
| HTTP status: 404 Not Found
BODY:
“status”: “Notification not found”
| нет обученного Агента со Слотом с таким вебхуком |
| HTTP status: 404 Not Found
BODY:
“status”: “There is no active channel for received event”
| Канал Проекта данного слота Notification удален\неактивен |
| HTTP status: 200 OK
BODY:
“status”: “Accepted for execution”
“task\_id”:
| Запрос на рассылку поставлен в очередь на выполнение |
### 2. Выполнение задачи на рассылку
1. Слот Notification собирает запрос в Конечный канал из параметров на вкладке Destination и идентификатора собеседника (phone\_number).\
2. Далее слот Notification выполняет отправку запроса на рассылку в выбранный в поле Destination Channel Конечный канал.
3. По итогу выполнения данного шага вы можете получить один из указанных в таблице результатов:
| Событие | Что записывается в переменную notification\_raw\_status | Что записывается в переменную notification\_status | Переход по Сценарию Агента |
| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------- |
| Не удалось составить запрос по какой-либо причине, например, не удалось спарсить и создать переменную, которая используется в id шаблона | {‘description’:’failed to build request’} | ‘failed’ | переход в ветку Notification fail |
| Конечный канал принял запрос и ответил успешным ответом | {‘description’:’received by channel’,
‘channel\_response’: тело ответа от канала (объект)}(если application/json = объект, если text = str; в иных cлучаях записывается null).
| ‘sent’ | Агент ожидает статуса обработки рассылки от Конечный канал |
| Запрос в Конечный канал ушел, но в ответ получен response с кодом 4хх или 5хх | {‘description’:’channel error <код ответа> ’channel\_response’: тело ответа от канала}Если в ответе на запуск рассылки пришел JSON-объект, то в ’channel\_response’ сохраняется этот JSON-объект. Если в ответе пришел текст, то сохраняется текст. В ином случае сохраняется None. | ‘failed’ | переход в ветку Notification fail |
| Не удалось выполнить запрос в Конечный канал (канал недоступен, пинг не идет и т.д.) | {‘description’:’channel inaccessible’} | ‘failed’ | переход в ветку Notification fail |
| В поле Content слота указаны данные несуществующего или несогласованного шаблона рассылки, при этом нет Активный диалог с получателем рассылки | {‘status’: ‘UNDELIVERED’, ‘error’: ‘not-template-match’} | | переход в ветку Notification fail |
| В поле Content слота указаны данные несуществующего или несогласованного шаблона рассылки, при этом естьАктивный диалог с получателем рассылки | | | получателю придет текст, указанный в поле Content, переход в ветку Notification success |
### 3. Переход в ветки подслотов и ответы из канала
После того как Конечный канал принял запрос на рассылку, происходит переход в один из Подслотов:
| Переход в Подслот | Причины | Что записывается в переменную notification\_raw\_status | Что записывается в переменную notification\_status |
| --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| Переход в ветку Notification Fail | Любые проблемы, относящиеся к данной конкретной задаче на рассылку, кроме отсутствия аккаунта на данном идентификаторе Собеседника | {‘description’:’channel couldn’t sent message’, ‘channel\_response’: тело ответа от канала}Если в ответе на запуск рассылки пришел JSON-объект, то в ’channel\_response’ сохраняется этот JSON-объект. Если в ответе пришел текст, то сохраняется текст. В ином случае сохраняется None | ‘failed’ |
| Переход в ветку Notification no account | Отсутствие аккаунта на данном идентификаторе Собеседника (в случае WhatsApp — номере телефона) | {‘description’:’no account on <номер телефона\ключевой идентификатор собеседника>’, ‘channel\_response’: тело ответа от канала as is (объект)} (если application/json = объект, если text = str; в иных cлучаях записывается null). | ‘no\_account’ |
| Переход в ветку Notification Success | Получение статуса отправки, доставки или прочтения сообщения Собеседником | {‘description’:’success’,‘channel\_response’: тело ответа от канала (объект)} (если application/json = объект, если text = str; в иных cлучаях записывается null). | ‘delivered’ |
| Переход в ветку Notification Success | получение Сообщение собеседника | {‘description’:’success’, ‘channel\_response’: тело принятного запроса от канала (объект), откуда распарсили текст Сообщение собеседника} (если application/json = объект, если text = str; в иных cлучаях записывается null). | ‘delivered’ |