Перейти к основному содержимому
Документация для версии v73

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

Notify fields​

{
  "sid": "notify",
  "fields": {
    "template": {
      "id": 1,
      "name": "message_after_purchase",
      "type": "NOTIFY",
      "status": "NOT_SENT",
      "is_draft": true,
      "edna_account_id": "",
      "notify_service_name": "altcraft_testing",
      "vk_data": {
        "body": "Содержание Notify сообщения",
        "buttons": [],
        "attachments": [],
        "enabled": true,
        "inline_keyboard": false,
        "hide_keyboard": false,
        "reply_enabled": false
      },
      "ok_data": {
        "enabled": true,
        "body": "Содержание Notify сообщения"
      },
      "sms_data": {
        "enabled": true,
        "body": "Содержание Notify сообщения",
        "type": "advert"
      },
      "routes": [
        {
          "route": "vk",
          "deliv_timeout": 86400,
          "read_timeout": 86400
        },
        {
          "route": "ok",
          "deliv_timeout": 86400,
          "read_timeout": 86400
        },
        {
          "route": "sms"
        }
      ]
    },
    "info": {
      "is_obsolete": false,
      "not_found": false
    },
    "params": {
      "name": "{{$.Lead._fname}}",
      "order_number": "{{$.Lead.order_number}}"
    }
  }
}

Описание​

ПараметрТипПримерОписание
namestring"message_after_purchase"Название шаблона
typestring"NOTIFY"Тип шаблона
statusstring"NOT_SENT"Статус отправки шаблона
is_draftbooleantrueЯвляется ли шаблон черновиком
edna_account_idstring"123456"ID аккаунта Edna
notify_service_namestring"altcraft_testing"Имя сервиса уведомлений
bodystring"Содержание Notify сообщения"Текст сообщения для VK
buttonsarray[]Кнопки в сообщении VK
attachmentsarray[]Вложения в сообщении VK
enabledbooleantrueВключено ли сообщение VK
inline_keyboardbooleanfalseИспользуется ли инлайн-клавиатура VK
hide_keyboardbooleanfalseСкрыть ли клавиатуру VK после отправки
reply_enabledbooleanfalseРазрешён ли ответ VK пользователю
enabledbooleantrueВключено ли сообщение в ОК
bodystring"Содержание Notify сообщения"Текст сообщения для ОК
enabledbooleantrueВключено ли SMS-сообщение
bodystring"Содержание Notify сообщения"Текст SMS-сообщения
typestring"advert"Тип SMS-сообщения
routestring"vk"Канал доставки
deliv_timeoutinteger86400Таймаут доставки (в секундах)
read_timeoutinteger86400Таймаут ожидания прочтения (в секундах)
routestring"ok"Второй канал доставки
routestring"sms"Третий канал доставки
is_obsoletebooleanfalseУстарел ли шаблон
not_foundbooleanfalseБыл ли шаблон найден

Telegram fields​

{
  "sid": "telegram_bot",
  "fields": {
    "image": {
      "attach": [
        {
          "content": "/9j/bcvb4234hgdffsd45",
          "filekey": "678636591824633380762bee",
          "name": "example.jpg",
          "size": 65101,
          "type": "image_path"
        }
      ]
    },
    "image_caption": "Описание Telegram bot сообщения",
    "markup_style": "HTML"
  }
}

Описание​

ПараметрТипПримерОписание
legacy_button_linkstring"https://example.com"Ссылка, прикреплённая к кнопке
legacy_button_namestring"button1"Название кнопки
markdown_typestring"HTML"Тип форматирования текста (HTML/Markdown)
textstring"example"Основной текст сообщения
contentstring"/9j/bcvb4234hgdffsd45"Бинарное содержимое файла (base64)
filekeystring"678636591824633380762bee"Уникальный идентификатор файла
namestring"example.jpg"Название прикреплённого файла
sizeinteger65101Размер файла в байтах
typestring"image_path"Тип вложения (например, путь к файлу)
image_captionstring"Описание изображения"Подпись к изображению
audio_captionstring"Описание аудиофайла"Подпись к аудиофайлу
video_captionstring"Описание видеофайла"Подпись к видеофайлу
markup_stylestring"HTML"Стиль разметки для Telegram (HTML/Markdown)

Whatsapp fields​

{
  "id": 9,
  "sid": "whatsapp",
  "fields": {
    "type": "TEMPLATE",
    "template": {
      "type": "360DIALOG",
      "name": "initiate_message_ru",
      "hsm_external_id": "c466caf6_c340_4d85_8659_6c9685618a9f_ru_initiate_message_ru",
      "language": "ru",
      "wa_account_id": "+79999999999",
      "hsm_hash_sum": "0b7ac0a91b0ba52e961b87c2297d2bd06a3f5bc1",
      "is_invalid": false,
      "hsm_not_found": false,
      "account_not_found": false
    },
    "raw_hsm": {
      "dialog_template": {
        "components": [
          {
            "type": "BODY",
            "text": "Здравствуйте! Благодарю за ожидание, мне понадобилось немного времени, чтобы уточнить информацию по вашему запросу. Подскажите, когда Вам будет удобно обсудить детали? 😃"
          }
        ],
        "name": "initiate_message_ru",
        "namespace": "c466caf6_c340_4d85_8659_6c9685618a9f",
        "category": "ISSUE_RESOLUTION",
        "language": "ru",
        "rejected_reason": "NONE",
        "status": "approved"
      },
      "edna_template": null
    }
  }
}

Описание​

ПараметрТипПримерОписание
typestring"360DIALOG"Тип шаблона WhatsApp
namestring"initiate_message_ru"Название шаблона
hsm_external_idstring"c466caf6_c340_4d85_8659_6c9685618a9f_ru_initiate_message_ru"Внешний ID шаблона
languagestring"ru"Язык шаблона
wa_account_idstring"+79999999999"ID WhatsApp-аккаунта
hsm_hash_sumstring"0b7ac0a91b0ba52e961b87c2297d2bd06a3f5bc1"Хэш шаблона
is_invalidbooleanfalseЯвляется ли шаблон некорректным
hsm_not_foundbooleanfalseНайден ли HSM шаблон
account_not_foundbooleanfalseНайден ли аккаунт
namestring"initiate_message_ru"Название шаблона в raw_hsm
namespacestring"c466caf6_c340_4d85_8659_6c9685618a9f"Namespace шаблона
categorystring"ISSUE_RESOLUTION"Категория шаблона
statusstring"approved"Статус шаблона (например, approved, rejected)
rejected_reasonstring"NONE"Причина отклонения шаблона (если есть)
components.typestring"BODY"Тип компонента шаблона
components.textstring"Здравствуйте! Благодарю за ожидание..."Текст тела сообщения
edna_templatestring"null"Шаблон Edna, если присутствует (в данном случае — отсутствует)

Viber™ fields​

"id": 10,
{
  "sid": "viber",
  "fields": {
    "series": [
      {
        "type": "TEXT",
        "text": "текст сообщения"
      },
      {
        "type": "IMAGE",
        "image": "/849074172/3/example.jpg"
      },
      {
        "type": "VIDEO",
        "thumbnail": "/848985842/3/678632345824633380762bee/example.jpg",
        "duration": 6,
        "file_size": 2,
        "action": "https://example.com/lib/preview/mp4/example.mp4"
      },
      {
        "type": "TEXT_BUTTON",
        "text": "Пример текста",
        "caption": "текст кнопки",
        "action": "https://example.com"
      },
      {
        "type": "FILE",
        "file_type": "pdf",
        "file_name": "example.pdf",
        "action": "https://www.example.org/testfiles/resources/pdf/example.pdf"
      }
    ]
  }
}

Описание​

ПараметрТипПримерОписание
typestring"TEXT"Тип элемента в серии сообщения
textstring"текст сообщения"Текстовое содержимое сообщения
imagestring"/849074172/3/example.jpg"Путь к изображению
thumbnailstring"/848985842/3/678632345824633380762bee/example.jpg"Превью для видео
durationinteger6Длительность видео в секундах
file_sizeinteger2Размер файла в мегабайтах
actionstring"https://example.com/lib/preview/mp4/example.mp4"Ссылка действия (для видео, кнопки или файла)
captionstring"текст кнопки"Подпись для кнопки
file_typestring"pdf"Тип файла (например, PDF)
file_namestring"example.pdf"Название прикреплённого файла

* Viber™ является товарным знаком Rakuten Group, Inc. Заблокирован на территории РФ.

Последнее обновление