Перейти к основному содержимому

Channel object

Используется в API запросах, связанных c добавлением и обновлением шаблонов сообщений.

{
  "sid": "email",
  "fields": {
    "text": "Hello, world!",
    "html": "<html>Hello, world!</html>",
    "subject": "Welcome"
  }
},
{
  "sid": "sms",
    "fields": {
      "sms": "Hello, world!"
    }
},
{
  "sid": "push",
  "fields": {
    "title": "Welcome",
    "body": "Hello, world!",
    "icon": "https://example.com/images/picture.jpg",
    "click_url": "https://example.com"
  }
}

Описание​

ПараметрТипПримерОписание
sidstring"email"
"sms"
"push"
"telegram_bot"
"telegram_group"
"custom_channel"		Название канала
fieldsobject
"fields": {
   "text": "Hello, world",
   "html": "Hello, world!",
   "subject": "Welcome"
 }
Настройки шаблона для конкретного канала

Fields object​

Каждый объект channel содержит объект fields:

Email fields​

{
  "sid": "email",
  "fields": {
    "text": "Текстовая версия письма",
    "html": "<html>HTML версия письма</html>",
    "subject": "Тема письма",
    "from_email": "test@example.com",
    "from_name": "Jenny's List",
    "replyto_email": "test_reply@example.com",
    "replyto_name": "Jenny",
    "is_not_inline": true
  }
}

Описание​

ПараметрТипПримерОписание
textstring"Hello, world!"Текстовая версия письма
htmlstring"<html>Hello, world!</html>"HTML версия письма
is_ampboolfalseЕсть ли в шаблоне amp-версия
ampstring"<html>Hello, world!</html>"AMP HTML версия письма
subjectstring"Weather alert"Тема сообщения
from_emailstring"test@example.com"Перезаписать from-email
from_namestring"Jenny's List"Перезаписать from-name
replyto_emailstring"test_reply@example.com"Перезаписать replyto_email
replyto_namestring"Jenny"Перезаписать replyto_name
is_not_inlinebooltrueНе конвертировать CSS в inline

SMS fields​

{
  "sid": "sms",
  "fields": {
    "sms": "Содержание SMS сообщения",
    "sms_max_count": 0,
    "add_sms_url_scheme": true
  }
}

Описание​

ПараметрТипПримерОписание
smsstring"Hello, world!"Текст сообщения
sms_max_countint0Лимит на количество SMS
add_sms_url_schemebooltrueДобавлять "http://" в ссылки

Push fields​

{
  "sid": "push",
  "fields": {
    "title": "Заголовок push уведомления",
    "body": "Содержание push уведомления",
    "icon": "https://example.com/images/icon.jpg",
    "click_url": "https://example.com",
    "custom_push_json_raw": "{}"
  }
}

Описание​

ПараметрТипПримерОписание
titlestring"Welcome"Заголовок сообщения
bodystring"Hello, world!"Текст сообщения
iconstring"https://example.com/images/test.jpg"URL-адрес, по которому расположена иконка для уведомления
click_urlstring"https://example.com"Ссылка для перехода по клику
custom_push_json_rawstring""Custom JSON для передачи в мобильный push
Последнее обновление