В этой статье описывается callback-функция для передачи информации об изменении статуса шаблона. Callback — это запрос, который передает на ваш сервер информацию об изменении статуса шаблона. Параметры запроса передаются в теле запроса.
URL-адрес подключения
Для получения callback-статусов шаблона в личном кабинете в секции Интеграция > Настройка в поле Callback URL для API управления укажите API-endpoint вашей системы, который будет обрабатывать входящие POST запросы от API-edna.
Поддерживается только протокол HTTPS.
Пример тела входящего POST запроса.
{ "messageMatcher": { "name": "new_matcher_2", "channelType": "WHATSAPP", "language": "RU", "content": { "header": { "headerType": "TEXT", "text": "Здравствуйте! Спасибо, что выбрали нас." }, "text": "string", "footer": { "text": "my footer text" } }, "category": "MARKETING", "status": "APPROVED", "locked": false, "type": "OPERATOR", "createdAt": "2022-05-05T11:34:34.844Z", "updatedAt": "2022-05-05T11:34:34.844Z" }, "subjectIds": [ 18594 ] }
Формат запроса
Параметр | Тип данных | Описание |
messageMatcher | object | Объект с данными о шаблоне |
name | string | Название шаблона |
channelType | string | Тип канала взаимодействия. Возможные значения: WHATSAPP , VIBER , SMS |
language | string | Язык шаблона |
content | object | Объект с содержимым шаблона |
category | string | Категория шаблона |
type | string | Тип шаблона. Возможные значения: • OPERATOR — операторский шаблон (шаблон, который был зарегистрирован у оператора связи);• USER — пользовательский шаблон (шаблон, который был создан пользователем на основе операторского шаблона) |
subjectIds | integer | Массив идентификаторов подписей, для которых создаётся шаблон. Чтобы узнать идентификатор подписи канала, используйте метод получения списка каналов. |
createdAt | string | Дата создания шаблона |
updatedAt | string | Дата обновления статуса шаблона |
status | string | Статус шаблона |
locked | boolean | Признак блокировки шаблона. Возможное значения: • TRUE — шаблон заблокирован;• FALSE — шаблон активен. |
Статусы шаблонов
- APPROVED — активный. Это единственный статус, при котором шаблон возможно использовать для отправки сообщений
- REJECTED — отклонен оператором
- PENDING — на регистрации
- NOT_SENT — черновик
- ARCHIVED — в архиве
- PAUSED — приостановлен
- DISABLED — отключен
Формат ответа
В ответ на запрос от вашего сервера должен возвращаться статус его выполнения с кодом 200.