Метод GetTemplate

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

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

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

Авторизация

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

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

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

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

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

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

Параметр	Тип	Описание
template	Template	данные о шаблоне

Template

Параметр	Тип	Описание
resource_id	uint64	идентификатор шаблона
template_name	string	название шаблона
template_text	string	текст шаблона
example_text	string	пример текста шаблона
alpha_name	string	имя отправителя (альфа-имя)
alpha_name_resource_id	uint64	идентификатор имени отправителя (альфа-имени)
operators	TemplateOperators	данные по операторам и категориям шаблона
history	TemplateHistory	история согласования шаблона у операторов
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	транзакционный

TemplateHistory

Параметр	Тип	Описание
action	string	действие
status	enum Status	статус согласования у оператора
action_date	string	дата действия в формате RFC-3339 / ISO-8601
comment	string	комментарий к действию

Примеры

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

{
    "template_resource_id": "132680"
}

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

{
    "template": {
        "resource_id": "132680",
        "template_name": "Заказ принят",
        "template_text": "Заказ: %w{1,n} %d на сумму %d руб принят. Планируемое время отгрузки в пункт выдачи: %d в интервале %d.",
        "example_text": "Заказ: SV TRT 860700 на сумму 7700 руб принят. Планируемое время отгрузки в пункт выдачи: 07.11.19 в интервале 17:00-20:00.",
        "alpha_name": "SHOP",
        "alpha_name_resource_id": "132669",
        "operators": [
            {
                "operator": 1,
                "status": 1,
                "template_category": 1
            }
        ],
        "history": [
            {
                "action": "МТС изменил статус на На согласовании",
                "status": 1,
                "action_date": "2023-10-30T16:36:36Z",
                "comment": ""
            }
        ],
        "creation_date": "2023-10-30T16:36:32.671312Z"
    }
}

GetTemplate