Получить информацию о шаблоне

Описание

Получить информацию о шаблоне сообщения.

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
format	string	"json"	Нет	Формат возвращаемых данных (по умолчанию – "json")
id	int	1	Да	Идентификатор шаблона сообщения
channel_sid	array of strings	["email", "sms", "cc_channel"]	Нет	Фильтр по каналам связи. Если указан, возвращаются только шаблоны для указанных каналов. По умолчанию - пустой массив (все каналы)
get_variable	boolean	true	Нет	Если true, в ответ включается список переменных (params), используемых в шаблоне. По умолчанию - false

Доступные типы переменных

Данные профиля

lead.fname, lead.lname, lead.email, lead.phone

lead.birthdate, lead.gender, lead._city, lead._country

lead._xxh, lead_custom.

Параметры

campid, workflow_id, workflow_name, msg_type

attribute_value, node_id

Даты и время

datenow, yearlong, hourse, minutes, ampm

Переменные apicontent

apicontent.field_1, apicontent.field_2, apicontent.field_N

Сегментация

segname

Подробнее про переменные, используемые в шаблонах, можно узнать в этой статье.

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

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "id": 1,
    "channel_sid": ["email", "sms", "cc_channel"],
    "get_variable": true
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <id>1</id>
  <channel_sid>email</channel_sid>
  <channel_sid>sms</channel_sid>
  <channel_sid>cc_channel</channel_sid>
  <get_variable>true</get_variable>
</xml>

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

JSON

{
    "data": {
        "id": 1,
        "updated_user": "example_user",
        "update_time": "2025-05-21T09:17:53.362Z",
        "name": "example template name",
        "description": "example template description",
        "channels": [
            {
                "id": 1,
                "sid": "email",
                "fields": {
                    "text": "example text version",
                    "html": "example html content",
                    "subject": "example subject",
                    "from_email": "example@example.com",
                    "from_name": "example from name",
                    "replyto_email": "reply@example.com",
                    "replyto_name": "example reply name",
                    "is_not_inline": true,
                    "attach": []
                },
                "params": [
                    "lead.fname",
                    "datenow",
                    "segname",
                    "apicontent.field_name",
                    "workflow_name"
                ],
                "presets": null
            },
            {
                "id": 2,
                "sid": "sms",
                "fields": {
                    "sms": "example sms content",
                    "sms_max_count": 0,
                    "add_sms_url_scheme": false
                },
                "params": [
                    "lead.fname",
                    "datenow",
                    "segname",
                    "apicontent.field_name",
                    "workflow_name"
                ],
                "presets": null
            }
        ],
        "json_url": "https://example.com/examples/message.json",
        "is_draft": true,
        "is_confirm": true,
        "ui_tags": [
            "example_tag_1",
            "example_tag_2"
        ],
        "groups": [
            {
                "id": 2,
                "name": "example_group_1"
            },
            {
                "id": 3,
                "name": "example_group_2"
            }
        ],
        "suppress_id": 1
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
  <data>
    <id>1</id>
    <updated_user>example_user</updated_user>
    <update_time>2025-05-21T09:17:53.362Z</update_time>
    <name>example template name</name>
    <description>example template description</description>
    <channels>
      <id>1</id>
      <sid>email</sid>
      <fields>
        <text>example text version</text>
        <html>example html content</html>
        <subject>example subject</subject>
        <from_email>example@example.com</from_email>
        <from_name>example from name</from_name>
        <replyto_email>reply@example.com</replyto_email>
        <replyto_name>example reply name</replyto_name>
        <is_not_inline>true</is_not_inline>
        <attach array='true'></attach>
      </fields>
      <params>lead.fname</params>
      <params>datenow</params>
      <params>segname</params>
      <params>apicontent.field_name</params>
      <params>workflow_name</params>
      <presets></presets>
    </channels>
    <channels>
      <id>2</id>
      <sid>sms</sid>
      <fields>
        <sms>example sms content</sms>
        <sms_max_count>0</sms_max_count>
        <add_sms_url_scheme>false</add_sms_url_scheme>
      </fields>
      <params>lead.fname</params>
      <params>datenow</params>
      <params>segname</params>
      <params>apicontent.field_name</params>
      <params>workflow_name</params>
    </channels>
    <json_url>https://example.com/examples/message.json</json_url>
    <is_draft>true</is_draft>
    <is_confirm>true</is_confirm>
    <ui_tags>example_tag_1</ui_tags>
    <ui_tags>example_tag_2</ui_tags>
    <groups>
      <id>2</id>
      <name>example_group_1</name>
    </groups>
    <groups>
      <id>3</id>
      <name>example_group_2</name>
    </groups>
    <suppress_id>1</suppress_id>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
id	int	Идентификатор шаблона сообщения
name	string	Название шаблона сообщения
description	string	Описание шаблона
channels	array of objects	Данные о настройках шаблона для каждого канала
channels[].id	int	Идентификатор канала в шаблоне
channels[].sid	string	Системный идентификатор канала (email, sms, push и т.д.)
channels[].fields	object	Настройки содержимого шаблона для канала
channels[].params	array of strings	Список переменных, используемых в шаблоне. Возвращается только при get_variable: true в запросе.
channels[].presets	object|null	Предустановленные настройки канала
json_url	string	URL для динамического JSON-контента
is_draft	bool	Если это черновик, то шаблон нельзя отправить
is_confirm	bool	Имеется ли ссылка подтверждения в теле письма
ui_tags	[]String	Список тегов для поиска
groups	array of objects	Список групп для поиска
suppress_id	int	Идентификатор стоп-списка
updated_user	string	Кем был обновлён шаблон
update_time	string	Когда был обновлён шаблон