Сравнение версий

Старая версия 4

changes.mady.by.user Кадубовский Андрей (Twin)

Сохранено

по сравнению с

Новая версия 5

changes.mady.by.user Кадубовский Андрей (Twin)

Сохранено

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

Наименование поля (русский вариант)Наименование поля (английский вариант)Обязательное/необязательноеОписание
адрес вебхука
Необязательное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@yandexriof86@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

...