CheckTemplate

Метод CheckTemplate

Примените метод CheckTemplate, чтобы перед отправкой шаблона на согласование операторам проверить, соответствует ли текст с переменными тексту сообщения с реальными значениями. Корректность данных повысит вероятность одобрения у операторов. Проверка бесплатна, предварительно регистрировать имя отправителя не нужно.

Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:

POST: https://api.exolve.ru/messaging/v1/CheckTemplate

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Имя Тип Описание
Authorization string API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Параметр Тип Описание
template_text string текст шаблона, допустимы переменные значения (например, %d или %w)
example_text string текст примера сообщения с реальными значениями (например, ФИО или адрес доставки)

Выходные параметры

Пустой JSON с 200 OK статусом.

Примеры

Входные параметры:

{
    "template_text": "Заказ: %w{1,3} на сумму %d руб. Доставит курьер %w Ожидаемое время доставки: %w{1,2} с %d до %d",
    "example_text": "Заказ: 101849 на сумму 5500 руб. Доставит курьер Олег Ожидаемое время доставки: 12 мая с 15:00 до 20:00"
}

Выходные параметры, если текст шаблона соответствует тексту сообщения:

{}

Возможные ошибки

Код Статус Пример сообщения Описание
400 Bad Request incorrect number format неверный формат данных в запросе или отсутствуют обязательные параметры
400 Bad Request can not write %{1,n} %{1,m}, where n+m > 20
400 Bad Request template can only support variables %w, %d, %d+, %w{1,n}, %d{1,n}, where n=[2,20]
401 Unauthorized incorrect authorization token невалидный API-ключ
403 Forbidden нет доступа к данными с предоставленным API-ключом
404 Not Found некорректно введен URL запроса

Содержание статьи