Наименование поля | Обязательное/необязательное | Описание |
---|---|---|
адрес вебхука | URL-адрес, на который будет отправляться запрос. Задается в произвольном формате. Ограничение 4000 байт. | |
Данные вебхука | Любые данные, которые можно использовать в сообщении вебхука. Задаются в виде массива в формате JSON. Ограничение 10240 байт. | |
Вложения | Вложения (например, изображения, аудио-файлы, документы), которые можно переслать в сообщении клиенту при помощи Vkontakte. Ограничение: не более 10 вложений в сообщении. Значение параметра задается в следующем формате: "<type><[-]owner_id>_<media_id>, photo|video|audio|doc|wall|market|poll". | |
Внешний идентификатор получателя | Идентификатор получателя сообщения во внешней системе. Задается в произвольном формате. Используется любая последовательность символов. Ограничение по длине: 10240 байт. | |
Время старта рассылки | Время начала рассылки. Задается в следующем формате: "НН-ММ-СС". | |
Дата старта рассылки | Дата начала рассылки сообщений. Значение данного параметра необходимо указывать в следующем формате: ГГ-ММ-ДД | |
Всегда отправлять | Если выбранный канал отправки сообщений не работает, то доставка сообщения будет выполнена с помощью мессенджера Viber. Реализовано в виде флажка "Обязательно" в разделе "Уведомления - Отправка сообщений". Возможные значения: True - параметр используется и False - параметр не используется | |
Длительность доставки | Длительность доставки сообщения. В качестве значения данного параметра используется целоей число в диапазоне от 1 - 2880 (макс. 48 часов). Если сообщение за это время не будет доставлено, то сообщение получит статус Expired. | |
Допустимое время отправки | Диапазон времени, в течение которого можно выполнять отправку сообщений. Значение параметра задается в формате JSON в виде строки: {"09:30:00", "12:00:00"} | |
Идентификатор бота | Идентификатор бота. Отображается для каждого сценария в личном кабинете в разделе "Сценарии - Сценарии". Задается в формате 54a096ef-3547-4c25-8832-f32193aa6f1b. | |
Идентификатор группы | Произвольный идентификатор для объединения сообщений в группу. Необязательный параметр. | |
Идентификатор загрузки | Произвольный глобальный идентификатор сообщения (bulk id). Необязательный параметр. | |
Идентификатор отправки | Идентификатор связанных сообщений (Flow id) для отправки через Viber. Задается вручную или генерируется автоматически. | |
Идентификатор получателя | Уникальный дентификатор (UID) клиентов кастомеров на платформе Twin | |
Идентификатор получателя в мессенджере | Номер телефона получателя сообщения для клиентской рассылки в мессенджере. Номер телефона задается в формате: 7хххххххххх | |
Идентификатор устройства | Уникальный идентификатор, который присваивается каждому установленному приложению на мобильном устройстве получателя push-сообщения | |
Идентификатор чат сессии | Служит для отсылки собщения в уже сущетвующую чат-сессиию. Идентификатор чат-сессии можно получить в диалоговом окне, которое отображается после нажатия на кнопку "Код фрейма" в кабинете администратора в разделе "Чаты - Настройки". | |
Идентификатор чата | Идентификатор чата указывается для каждого чата в личном кабинете в разделе "Чаты - Настройки". Имеет следующий формат: 7db1220a-71212-41212-9127-31212121212 | |
Идентификатор шаблона | Идентификатор шаблона задания на обзвон. Задается в следующем формате: "7bd154fd-9d45-4a06-996a-2da0c463e57a". Отображается для каждого шаблона задания на обзвон в личном кабинете администратора в разделе "Вызовы - Шаблоны заданий". | |
Имя отправителя | Зергистрированное имя отправителя, которое отображается клиенту при получении сообщения в поле "От кого". Зарегистрированное имя отправителя, которое используется в системе по умолчанию: TwinService | |
Имя чат сессии | Имя чат-сессии оператора чата. Имеет следующий формат: "99cb0c63-0e39-4faf-89ca-e588a07821fe". Служит для создания чат-сессии. Содержится в ежемесячном подробном платежном отчете по сервису чатов в личном кабинете администратора в разделе "Статистика - Отчеты". | |
Использовать короткие ссылки | Данный параметр предназначен для конвертации любого url-адреса, который содержится в тексте ообщения, в коротку ссылку вида "https://2wn.me/wfi8". Возможные значения: true (параметр используется) и false (параметр не используется). | |
Канал | Название канала отправки сообщений. Данный параметр может содержать только одно значение. Возможные значения: email, sms, puah, viber, whatsapp, chat, vkontakte, odnoklassniki. Значение даного параметра соответствует значению, которое задается в поле "Шаблоны сообщений по каналам" при создании нового шаблона уведомления в личном кабинете администратора в разделе "Уведомления - Шаблоны". | |
Каналы | Названия нескольких каналов отправки сообщений. Возможные каналы: email, sms, push, viber, whatsapp, chat, vkontakte, odnoklassniki. Каналы указывааются в строке в виде JSON-структуры. Данный параметр поддерживается не всеми провайдерами. Параметр используется только в том случае, если техническая поддержка компании Twin говорит, что его необходимо использовать. Значение параметра задается в следующем формате: "channels": { "email": { "text": "string", "subject": "string", "fromEmail": "pupkin@contora.com", "fromName": "Vasya Pupkin", "provider": "APN", "validityPeriod": 10 }, "sms": { "text": "string", "from": "CompanyName", "provider": "APN", "validityPeriod": 10 }, "push": { "text": "string", "from": "string", "provider": "APN", "validityPeriod": 10 }, "viber": { "text": "string", "from": "string", "imageUrl": "string", "buttonUrl": "string", "buttonText": "string", "provider": "APN", "validityPeriod": 10 }, "whatsapp": { "from": "string", "templateName": "string", "templateNamespace": "string", "templateData": [ "string" ], "language": "string", "mediaUrl": "string", "text": "string", "provider": "APN" }, "vkontakte": { "from": "string", "templateName": "string", "templateData": [ "string" ], "text": "string", "provider": "APN", "attachments": [ "video-85635407_165186811", "wall-92255884_16" ] }, "odnoklassniki": { "templateName": "string", "templateData": [ "string" ], "text": "string", "provider": "APN" }, "chat": { "chatId": "bce7d22e-dde6-4427-b391-ebbdfda44de6", "botId": "bce7d22e-dde6-4427-b391-ebbdfda44de6", "messengerType": "WHATSAPP", "chatSessionName": "string", "provider": "APN", "continueLastOrStartNewSession": true } | |
Название шаблона | Название cистемного шаблона, который используется для создания шаблонов уведомлений в следующих мессенджерах (whatsapp, chat, vkontakte, odnoklassniki). | |
Пространство имен шаблонов | Зарегистрированное пространство имен шаблона сообщений для работы с WhatsApp Business API | |
От кого | Зарегистрированное имя отправителя. Данное имя будет отображаться в качестве имени отправителя сообщения в мессенджере Whatsapp. | |
Отправить в | Начало периода, в течение которого производится отправка сообщения. Значение данного параметра задается в разных форматах (например, ГГ-ММ-ДД НН:ММ:СС). В качестве значения можно указывать только дату (ГГ-ММ-ДД). Если в значении указать только время, то параметр не будет использоваться. | |
Переменные | Переменные задаются в формате JSON (название переменной - формат). | |
Переменные шаблона | Список переменных, которые будут использоваться в сообщениях. Данный параметр используется только для шаблона мессенджера WhatsApp. Значения задаются в формате JSON (название переменной - формат). | |
Платформа | Название мобильной платформы на устройстве клиента. Данный параметр предназначен только для push-сообщений. Возможные значения: "android, ios". | |
Получатель | Получатель сообщения. Значение параметра задается в формате JSON в виде объекта "destinations". Пример использования данного параметра: "destinations": [ { "flowId": "string", "phone": 41793026731, "email": "pupkin@contora.com", "messengerUserId": "string", "externalId": "string", "clientId": "bce7d22e-dde6-4427-b391-ebbdfda44de6", "pushRegistrationId": "string", "platform": "ANDROID", "chatSessionId": "bce7d22e-dde6-4427-b391-ebbdfda44de6", "variables": { "var1": "value1", "var2": "value2", "var3": "value3" } } ], | |
Почта отправителя | Адрес электронной почты отправителя, на который будет отправлен ответ, после того как клиент ответит на сообщение. Задается в следующем формате: "riof86@yandex.ru". | |
Продолжить последнюю сессию или начать новую | Данный параметр управляет типами сессий в чате. Возможне значения: "true" и "false". "True" - возоббновляется старая сесия; если старой сессии нет, то создается новая сессия. "False" - всегда создается новая сессия. | |
Ссылка на изображение | URL-адрес веб-страницы, которая в сообщении Viber будет передаваться в виде картинки | |
Ссылка на изображение кнопки | URL-адрес для отправки заданного текста любому контакту в мессенджере Viber при нажатии на кнопку "Поделиться" на веб-странице. Задается в следующем формате: "viber://forward?text=<Your Text> " | |
Ссылка на медиа-файл | URL-адрес медиафайлa, который будет прикреплен к сообщению в Whatsapp. Пример использования параметра: "MediaUrl=https://demo.twilio.com/owl.png" | |
Текст кнопки | Текст, который отображается на кнопке быстрого ответа в сообщении Whatsapp. Ограничение по количеству символов: 20. | |
Текст сообщения | Текст сообщения для клиентской рассылки. Ограничение по количеству символов отсутствует. Для смс-рассылок текст сообщения может разбиваться на несколько смс-сообщений. | |
Телефон | Номер телефона кандидата на обзвон или номер телефона, который система использует для выполнения клиентской рассылки. Номер телефона задается в формате: 7хххххххххх | |
Тема | Тема сообщения, рассылаемого по электронной почте. Значение данного параметра отображаться в поле "Тема". Для мобильных устройств в качестве значения данного параметра рекомендуется использовать не более 30 символов. Для почтовых клиентов на рабочей станции в качестве значения данного параметра рекомендуется использовать не более 60 символов. | |
Тип мессенджера | Тип мессенджера, который используется для выполнения клиентской рассылки при выборе шаблона для канала "chat". Доступные значения: whatsapp, viber, facebook, telegram, vkontakte, skype, slack, alice, imessage. | |
Электронная почта | Адрес электронной почты получателя. Значение данного параметра не поддерживает указание некольких адресов электронной почты. | |
Язык | Язык шаблона сообщений. В качестве значений можно использовать любые языки. На текущий момент возможные значения: ru (русский), en (английский) | |
Провайдер | Данный параметр не используется до появления прямых инструкций со стороны разработчика компании Twin |
Обзор
Инструменты контента