Метод GetTemplates

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

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

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

Авторизация

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

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

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

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

Параметр	Тип	Описание
limit	uint64	лимит выводимых строк
offset	uint64	номер строки, с которой начинать выборку (начинается с 0)
resource_id	uint64	идентификатор шаблона
template_name	string	название шаблона
alpha_name	string	имя отправителя

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

Параметр	Тип	Описание
templates	Templates	массив с данными о шаблонах

Templates

Параметр	Тип	Описание
resource_id	uint64	идентификатор шаблона
template_name	string	название шаблона
template_text	string	текст шаблона
alpha_name	string	имя отправителя (альфа-имя)
alpha_name_resource_id	uint64	идентификатор имени отправителя (альфа-имени)
operators	TemplateOperators	данные по операторам и категориям шаблона
creation_date	string	дата создания в формате RFC-3339 / ISO-8601

TemplateOperators

Параметр	Тип	Описание
operator	enum Operator	название оператора
status	enum Status	статус согласования у оператора
template_category	enum Category	категория шаблона

Operator

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

Status

Параметр	Тип	Описание
1	enum	на согласовании
2	enum	согласован
3	enum	отклонён
4	enum	отключён

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

Примеры

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

{
    "alpha_name": "SHOP"
}

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

{
    "templates":[ 
        {
            "resource_id": 132680,
            "template_name": "Заказ принят",
            "template_text": "Заказ: %w{1,n} %d на сумму %d руб принят. Планируемое время отгрузки в пункт выдачи: %d в интервале %d.",
            "alpha_name": "SHOP",
            "alpha_name_resource_id": 132669,
            "operators": [
                {
                    "operator": 1,
                    "status": 1,
                    "template_category": 1
                }
            ],
            "creation_date": "2023-10-30T16:36:32.671312Z"
        },
        {
            "resource_id": 132683,
            "template_name": "Доставка заказа",
            "template_text": "Заказ: %w{1,3} на сумму %d руб. Доставит курьер %w. Дата доставки: %w{1,2} с %d по %d",
            "alpha_name": "SHOP",
            "alpha_name_resource_id": 132669,
            "operators": [
                {
                    "operator": 2,
                    "status": 1,
                    "template_category": 3
                },
                {
                    "operator": 3,
                    "status": 1,
                    "template_category": 3
                }
            ],
            "creation_date": "2023-10-30T16:36:32.671312Z"
        },
    ]
}

GetTemplates