Получение статуса регистрации шаблона

В этой статье описывается 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": "ACCOUNT_UPDATE",
        "status": "APPROVED",
        "locked": false,
        "type": "OPERATOR",
        "createdAt": "2022-05-05T11:34:34.844Z",
        "updatedAt": "2022-05-05T11:34:34.844Z"
    },
    "subjectIds": [
        18594
    ]
}

Формат запроса

ПараметрТип данныхОписание
messageMatcherobjectОбъект с данными о шаблоне
namestringНазвание шаблона
channelTypestringТип канала взаимодействия. Возможные значения: WHATSAPP, VIBER, SMS
languagestringЯзык шаблона
contentobjectОбъект с содержимым шаблона
categorystringКатегория шаблона
typestringТип шаблона. Возможные значения:

OPERATOR — операторский шаблон (шаблон, который был зарегистрирован у оператора связи);
USER — пользовательский шаблон (шаблон, который был создан пользователем на основе операторского шаблона)
subjectIdsintegerМассив идентификаторов подписей, для которых создаётся шаблон. Чтобы узнать идентификатор подписи канала, используйте метод получения списка каналов.
createdAtstringДата создания шаблона
updatedAtstringДата обновления статуса шаблона
statusstringСтатус регистрации шаблона
lockedbooleanПризнак блокировки шаблона. Возможное значения:

TRUE — шаблон заблокирован;
FALSE — шаблон активен.

Формат ответа

В ответ на запрос от вашего сервера должен возвращаться статус его выполнения с кодом 200.

Создание шаблона
Cледующая статья Получение списка шаблонов