Получить список шаблонов

Описание

Получить список всех шаблонов сообщений.

URL-адрес

Метод: POST

https://example.com/api/v1.1/templates/list

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
format	string	"json"	Нет	Формат возвращаемых данных (по умолчанию – "json")
from_id	int	1	Нет	Идентификатор первого шаблона в ответе (по умолчанию – 1)
limit	int	100	Нет	Лимит на количество возвращаемых данных (по умолчанию – 1000)
channel	string	"email" "sms" "push" "telegram_bot" "telegram_group" "custom_channel"	Нет	Канал, в котором используется шаблон (по умолчанию – все каналы)
ui_tags	[]String	["tag1", "tag2"]	Нет	Список тегов для поиска (по умолчанию – [])
groups	[]String	["group1", "group2"]	Нет	Список групп для поиска (по умолчанию – [])
groups_id	[]int	[0, 1]	Нет	Список Id групп для поиска (по умолчанию – [])

Пример запроса

JSON

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "limit": 2
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <limit>2</limit>
</xml>

Пример ответа

JSON

{
  "data": [
    {
      "id": 1,
      "name": "Message A",
      "channels": [
        "email"
      ]
    },
    {
      "id": 2,
      "name": "Message B",
      "channels": [
        "push"
      ]        
    }
  ],
  "error": 0,
  "error_text": "Successful operation",
  "total_count": 10
}

XML

<result>
  <data>
    <id>1</id>
    <name>Message A</name>
    <channels>email</channels>
  </data>
  <data>
    <id>2</id>
    <name>Message B</name>
    <channels>push</channels>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <total_count>10</total_count>
</result>

Возвращаемые параметры

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
total_count	int	Общее количество шаблонов
id	int	Идентификатор шаблона сообщения
name	string	Название шаблона сообщения
channels	array	Каналы, для которых настроен шаблон
is_draft	bool	Если это черновик, то шаблон нельзя отправить
is_confirm	bool	Имеется ли ссылка подтверждения в теле письма
ui_tags	[]String	Список тегов
groups	array of objects	Список групп (id группы + название группы)