CreateTemplate

Метод CreateTemplate

Примените этот метод для создания SMS-шаблона. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

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

Авторизация

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

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

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

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

Параметр Тип Описание
template_name string название шаблона
alpha_name string имя отправителя (альфа-имя)
template_text string текст шаблона
example_text string пример текста шаблона
template_category enum TemplateCategory категория шаблона

TemplateCategory

Параметр Тип Описание
category_type enum CategoryType тип шаблона
operators enum Operators операторы связи

CategoryType

Параметр Тип Описание
1 enum авторизационный
2 enum сервисный
3 enum транзакционный

Operators

Параметр Тип Описание
1 enum МТС
2 enum МегаФон
3 enum Билайн
4 enum Теле2
6 enum Ростелеком

Соотношение категорий к операторам

Авторизационный Сервисный Транзакционный
МТС ✅ ✅ ✅
МегаФон ✅ ✅ ✅
Билайн ❌ ✅ ✅
Tele2 ❌ ✅ ✅
Ростелеком ❌ ✅ ✅

Для каждого оператора можно выбрать только одну категорию:

  • Авторизационными признаются SMS, содержащие коды, пароли, логины, OTP (one-time password — одноразовые пароли) и т.д.
  • Сервисные SMS, как правило, уведомляют о доставке товара, напоминают о предстоящих мероприятиях или информируют о результатах рассмотрения обращений. Исключение — Tele2. Сервисное (идентификационное) SMS абонентам Tele2 должно содержать коды, пароли и логины для прохождения авторизации, верификации, подтверждения каких-либо действий или предоставления согласий.
  • Транзакционные SMS используются для информирования пользователей об операциях с денежными средствами, либо о невозможности выполнения такой операции.

Подробнее о требованиях к шаблонам можно прочитать здесь.

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

Параметр Тип Описание
template_resource_id uint64 идентификатор шаблона

Примеры

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

{
    "alpha_name": "SHOP",
    "template_name": "Доставка заказа",
    "template_text": "Заказ: %w{1,3} на сумму %d руб. Доставит курьер %w. Дата доставки: %w{1,2} с %d по %d",
    "example_text": "Заказ: 1234 на сумму 1000 руб. Доставит курьер Олег. Дата доставки: 12 мая с 15:00 по 20:00",
    "template_category": [
        {
            "template_category_type": 2, // сервисная
            "operators": [
                1, 3 // МТС, Билайн
            ]
        },
        {
            "template_category_type": 1, // авторизационная
            "operators": [
                2 // МегаФон
            ]
        }
    ]
}

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

{
    "template_resource_id": 132637
}

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