Получение шаблонов
get
https://direct.i-dgtl.ru/api
/v1/templates/{template_id}
Получение шаблона по id

Описание объекта шаблона

Параметр
Тип
Описание
id
integer
Идентификатор шаблона
channelType
string
templateType
string
pattern
string
Текст шаблона
dateFrom
string
Дата начала действия
dateTo
string
Дата окончания действия
senderNameId
integer
Идентификатор имени отправителя, на которое зарегистрирован шаблон
senderName
string
Имя отправителя
brand
string
Оператор (только для SMS-шаблонов)
countryCode
string
Код страны (только для VIBER-шаблонов)
managerComment
string
Комментарий менеджера
status
string
createdAt
string
Дата создания шаблона
rejectedAt
string
Дата отклонения шаблона
content
object
Контент шаблона (только для WHATSAPP-шаблонов, описан ниже)

Контент WHATSAPP-шаблона

Текстовый заголовок и кнопки
Интерактивный заголовок и кнопки
{
"header": {
"type": "text",
"text": "Текст заголовка {{1}}"
},
"text": "Текст сообщения {{2}}",
"footer": "Текст подписи",
"buttons": [
{
"text": "Текст кнопки 1"
},
{
"text": "Текст кнопки 2"
},
{
"text": "Текст кнопки 3"
}
}
}
{
"header": {
"type": "image"
},
"text": "Текст сообщения {{1}}",
"footer": "Подпись сообщения",
"buttons": [
{
"text": "Кнопка-ссылка",
"url": "https://i-dgtl.ru"
},
{
"text": "Кнопка-вызов",
"phone": "78000000000"
}
]
}
Параметр
Тип
Описание
content.header
object
Объект с информацией о заголовке сообщения
content.header.type
string
Тип заголовка; принимает значения:
text
image
document
content.header.text
string
Текст заголовка; присутствует только при header.type = text
content.text
string
Текст сообщения
content.footer
string
Подпись сообщения
content.buttons
array
Массив объектов с кнопками
content.buttons.text
string
Текст кнопки
content.buttons.url
string
Ссылка, на которую произойдет переход при нажатии на кнопку
content.buttons.phone
string
Телефонный номер, на который произойдет вызов при нажатии на кнопку

Формирование WHATSAPP-сообщения

Для того, чтобы сформировать из WHATSAPP-шаблона контент WHATSAPP-сообщения, необходимо:
  1. 1.
    Добавить параметр content.contentType со значением "text"
  2. 2.
    Заполнить подстановки: параметры content.header.text и content.text могут содержать переменные вида {{1}}, {{2}}, которые необходимо заменить на строки
  3. 3.
    Удалить параметр content.header.type из заголовка
  4. 4.
    Добавить интерактивное содержимое в заголовок:
    1. 1.
      если content.header.type = document, то нужно добавить
      1. 1.
        content.header.documentUrl — ссылка на документ
      2. 2.
        content.header.documentName — название документа, которое будет отображено абоненту
    2. 2.
      если content.header.type = image, то нужно добавить
      1. 1.
        content.header.imageUrl — ссылка на изображение
  5. 5.
    Преобразовать строку content.footer в строку content.footer.text, добавив вложенный объект content.footer
  6. 6.
    Для кнопок, у которых отсутствует content.buttons.url / content.buttons.phone, необходимо добавить строку content.buttons.payload
get
https://direct.i-dgtl.ru/api
/v1/templates
Получение массива шаблонов
Возможные варианты перечислений:

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

Получение сервисных шаблонов, зарегистрированных на операторов Теле2 и Билайн в статусах "Одобрено" и "Закрыто"
JSON
cURL
GET https://direct.i-dgtl.ru/api/v1/templates?template_type=SERVICE&brand=TELE2&brand=BEELINE&status=APPROVED&status=CLOSED
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
curl -X GET 'https://direct.i-dgtl.ru/api/v1/templates?template_type=SERVICE&brand=TELE2&brand=BEELINE&status=APPROVED&status=CLOSED' \
-H 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
Получение VIBER-шаблонов, действующих в РФ, в статусе "Одобрено"
JSON
cURL
GET https://direct.i-dgtl.ru/api/v1/templates?channel_type=VIBER&country_code=ru&status=APPROVED
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
curl -X GET 'https://direct.i-dgtl.ru/api/v1/templates?channel_type=VIBER&country_code=ru&status=APPROVED' \
-H 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
Copy link
On this page
get
Получение шаблона по id
Описание объекта шаблона
Контент WHATSAPP-шаблона
Формирование WHATSAPP-сообщения
get
Получение массива шаблонов
Примеры запроса