Оглавление
indent 0px separator brackets

Основные функции сервиса уведомлений:

1. Отправка текстовых уведомлений пользователям.

2. Отложенная отправка (сообщение отправится в определенное установленное время, установленное заранее). При необходимости можно отменить отправку сообщения до наступления заранее установленного времени. Благодаря этому можно контролировать, что сообщение не придет пользователю в неположенное время (например, ночью).

3. Сокращение ссылок. Длинные ссылки сокращаются для уменьшения стоимости отправки сообщения, это . Это касается только канала sms SMS (подробнее см. в разделе "Отправка уведомлений через API").

4. Использование шаблонов. Для того, чтобы Чтобы не передавать каждый раз весь массив данных  данных уведомления через API, можно собрать создать шаблон, описывающий всю структуру сообщения, и менять только номер телефона или email электронный адрес получателя и переменные.

5. Отправка уведомлений по различным каналам: smsSMS, e-mail, push, WhatsApp, Viber, Telegram, Vkontakte, Odnoklassniki, chat. По умолчанию сообщения отправляются последовательно: если сообщение было доставлено по одному из каналов сообщение было доставлено, то по остальным каналам оно не отправляется.

панель
borderColor #000080 bgColor #F0FFFF borderWidth 2px borderStyle solid
Отправка уведомлений при помощи задания на отправку

Для отправки смс SMS-сообщений, рекламных сообщений, старта чат сессий, запуска чат сессий в WhatsApp, а также уведомлений с помощью API через систему TWIN необходимо зайти во вкладку Уведомления и выбрать подраздел , выполните следующее:

1. Перейдите на вкладку Уведомления – Задания на отправку.

Image Modified

Затем нажать        2. Нажмите кнопку Добавление нового задания на отправку сообщений.

Image Modified

Указать наименование здания, затем выбрать тип уведомления, после этого автоматически        3. Введите наименование задания, выберите тип уведомления. После этого будет загружен шаблон для данного типа уведомления.

Далее необходимо открыть        4. Откройте загруженный шаблон и заполнить заполните его согласно согласно таблице описания полей.

Image Modified

Затем загрузить        5. Загрузите заполненный шаблон в то же задание на отправку и нажать на Создать.

Подробнее (см. здесь).  

Рекламные сообщения

.

Рекламные сообщения

Для Для отправки рекламных сообщений необходимо знать требуется идентификатор сессии с клиентом. Найти его можно в отчёте по диалогам диалогах чата.

Image Modified

У каждой Каждая чат сессии -сессия с клиентом есть имеет свой идентификатор. Именно на него и будет происходить отправка.

Image Modified

Итак, заказчик собирает данные по идентификаторам чат сессий своих клиентов из нашей платформы, и хочет сделать по ним отправку. 

Шаблон отправки рекламных сообщений.

для отправки рекламных сообщений нужно собрать идентификаторы чат-сессий с нужными клиентами. 

Добавление нового задания на отправку сообщений

1. Перейдите в раздел Уведомления – Задания на отправку и нажмите кнопку Добавление нового задания на отправку сообщений

1. .

Image Modified

      2. В открывшемся окне нажмите на ссылку Рекламные сообщения, чтобы скачать шаблон для отправки рекламных сообщений, нажав на него:.

Image Modified

Поля Описание полей шаблона.:

1. идентификатор чат сессии-  идентификатор чат- заполняется идентификтором чат сессии клиента (в нашем примере то, что мы скопировали выше) которому хотим написать;сессии с клиентом, которому нужно отправить рекламное сообщение.

2. использовать короткие ссылки - атрибутпараметр, отвечающий который отвечает за сокращение ссылки длины ссылок в тексте вашего сообщения, если там будут ссылки:сообщения для уменьшения стоимости отправки сообщения.

   1. true - ссылки будут сокращаться;сокращаются

   2. false - ссылки будут остаются в неизменном виде.

3. продолжить последнюю сессию или начать новую - атрибут, отвечающий за токоторый определяет, будет ли ваше сообщение начинать новую сессию при отправке сообщения создаваться новая чат-сессия с клиентом или продолжит последнююостанется старая:

   1. true - начнётся новая сессия, с новым идентификатором чат сессии;

   2. false - сообщение придёт в текущую чат сессию, не меняя ее идентификаторидентификатора.

4. текст сообщения - сообщение, которое хотим нужно отправить клиенту;

5. провайдер -  платформа, через какую платформу которую происходит отправка . Указываем TWIN(значение по умолчанию: TWIN);

6. канал - поскольку мы пишем в чат, указываем chatканао коммуникации с клиентом (значение по умолчанию: chat).

Отправка рекламных сообщений

После заполнения шаблона .Заполнив шаблон, нужно сформировать задание. Для этого выполните следующее:

1. Введите название задания на отправку.

2. Загрузите

3. Дать название;

4. Загрузить файл с заполненным шаблоном;.

5. Укажите период времени, в течение которого клиенту будет отправлено Выставить время, в которое клиент может получить сообщение;

6. Нажать "кнопку Создать".

Image ModifiedДалее

необходимо запустить задание      5. Запустите задание.

Image Modified

Для отправки уведомлений через API необходимо создать шаблон на отправку сообщений. Для этого нужно открыть вкладку Уведомления, выбрать подраздел Шаблоны и открыть нужный шаблон.

Заполнить все поля.

Затем перейти на страницу https://tcl.twin24.ai/doc/notify/index.html и выполнить запрос POST /messages.

Для этого необходимо заполнить тело запроса.

Задать следующие параметры: 

groupId - идентификатор группы, в случае, если нужно отправить одно сообщение сразу на несколько устройств одного человека; 

taskId - идентификатор задачи;

useShortLinks -  использование коротких ссылок (значения true/false); 

allowedTimeRanges - разрешенный период отправки, указывается время в формате H:i:s (ЧЧ:ММ:СС);

templateId - идентификатор шаблона (например, 0de36c39-46a2-4426-b16c-c2a86e844311);

destinations - направление отправки, например, номер телефона получателя или email;

variables - ячейки, хранящие в себе определенные значения, которые могут меняться (например, имя получателя, для этого необходимо задать переменную {name});

channels - каналы отправки (sms, email, WhatsApp и т.д.), в каждом канале можно указать текст сообщения, даже если он не указан в шаблоне, в этом случае текст, указанный в канале, является приоритетным.

Если сообщение не дошло по одному каналу (например, sms), оно отправляется по следующему каналу (например, Viber), если же сообщение дошло, то дальше по остальным каналам оно не отправляется. Но если все-таки необходимо отправить сообщение по дополнительному каналу, помимо sms (например, Viber), независимо от того, дошло оно по каналу sms или нет, в параметрах этого канала нужно установить required: true

Дополнительные параметры:

imageUrl - ссылка на изображение

buttonUrl - ссылка, которая открывается после нажатия на кнопку

buttonText - кнопка с текстом

validityPeriod - период времени, в течение которого отправитель получает уведомление о доставке сообщения (в минутах).

Для отправки уведомлений по разным каналам (WhatsApp, Vkontakte и т.д.) на странице https://tcl.twin24.ai/doc/notify/index.html есть примеры тела запроса.

Если запрос успешно отправлен, в личном кабинете TWIN во вкладке Просмотр сообщений изменится статус сообщения на “Отправляется”, а затем на “Доставлено”.

Старт чат-сессии в телеграмм через API

Для того, чтобы отправить сообщение в Телеграмм через API, необходимо добавить телеграмм бота.

Добавление telegram бота:

1. Открыть telegram клиент.
2. Написать боту BotFather команду /start
3. Далее следовать инструкциям по созданию нового бота.
4. Взять API token в настройках созданного бота.
5. Чтобы привязать бота к конкретному чату следует воспользоваться соответствующим АПИ: https://chat-api.twin24.ai/docs/index.html

Далее необходимо создать чат в личном кабинете TWIN и привязать его к сервису, следуя данной инструкции. 

заполнить в теле запроса POST /messages следующие параметры:

Параметр chatId можно найти во вкладке Чаты - Настройки

Далее необходимо выбрать свой чат и нажать Просмотреть диалог

В открывшемся окне вы найдете идентификатор клиента (chatId).

Параметр chatId также находится во вкладке Чаты - Настройки

Найти свой чат и нажать на кнопку копирования.

WhatsApp

Для того, чтобы отправлять сообщения через канал WhatsApp, необходимо получить бизнес-аккаунт в Facebook* и подключить чат к WhatsApp.

1. Пользователю необходимо убедиться, что его бизнес соответствует Коммерческой политике WhatsApp: https://www.whatsapp.com/legal/commerce-policy/
   А также, убедиться, что сообщения будут соответствовать политике WhatsApp Business:
   https://www.whatsapp.com/legal/business-policy/
2. Заполнить анкету https://forms.gle/6a8fJohENvwhVPhC9
3. Подтвердить бизнес-аккаунт Facebook* https://www.facebook.com/business/help/2058515294227817
4. Принять запрос для WhatsApp Business API. (После заполнения анкеты примерно через 2-3 дня) https://business.facebook.com/settings/requests

В противном случае, анкета не будет одобрена.

5. После того, как ваша учетная запись WhatsApp будет одобрена и учетная запись настроена, мы сможем завершить процедуру OTP (One Time Password) для активации вашего номера с помощью WhatsApp API. Этот OTP можно отправить с помощью голосового вызова или SMS: предварительно согласовав время, вам поступит звонок или SMS (как вам будет удобнее) с уведомлением одноразового кода. Этот код нужно будет сообщить вашему партнеру или быть на связи с технической поддержкой. Время жизни кода всего 5 минут.

6. 1 день на донастройку аккаунта WahtsApp и подключение к чатам TWIN.

После этого пользователь сможет создать и настроить шаблон для отправку уведомлений в WhatsApp и посмотреть, как будет выглядеть чат в WhatsApp с созданным им шаблоном.

При создании шаблона необходимо заполнить поле "Header" (заголовок), в который можно загрузить изображения, документы, видео и геолокацию, либо написать текст приветствия, который будет выделен в сообщении жирным шрифтом. Поле "Body" заполняется основным текстом сообщения. Также есть возможность добавить кнопки быстрых ответов в самом сообщении.

Затем шаблон отправляется на модерацию. После того, как шаблон прошел модерацию и был одобрен, им можно пользоваться для отправки уведомлений в WhatsApp.

Vkontakte

Для отправки уведомления Vkontakte необходимо создать шаблон, для этого нужно открыть вкладку Шаблоны mail.ru и нажать Новый шаблон.

После этого откроется окно создания шаблона, которое нужно заполнить в соответствии с правилами https://notify.mail.ru/#notifications. Нажать кнопку Сохранить.

2) В поле Имя шаблона укажите имя создаваемого шаблона. По этому имени вы позднее сможете идентифицировать шаблон в списке.

3) В поле Email укажите электронный адрес, который вы использовали для регистрации страницы в социальных сетях "Vkontakte" и "Одноклассники".

4) В поле Тело шаблона общее для всех введите текст сообщения, который будет отображаться для пользователей социальных сетей "Vkontakte" и "Одноклассники".

5) В поле Тело шаблона для Вконтакте введите текст сообщения, которое будет отображаться только пользователей социальной сети "Vkontakte".

6) В поле Группа Вконтакте укажите url-адрес группы пользователей в социальной сети "Vkontakte", которым нужно отправить сообщение.

7) В поле Тело шаблона для Одноклассники введите текст сообщения, которое будет отправлено только пользователям социальной сети "Одноклассники".

8) В поле Группа Одноклассники укажите url-адрес группы пользователей в социальной сети "Одноклассники", которым нужно отправить сообщение.

9) Для сохранения изменений нажмите кнопку Сохранить.

После этого шаблон отправляется на модерацию mail.ru. В случае его одобрения, на e-mail, указанный в шаблоне, придет уведомление об одобрении. 

Затем этот шаблон можно будет использовать для отправки сообщение как через личный кабинет TWIN, так и через API.

Отправка уведомления vkontakte через API

Для того, чтобы отправить уведомление vkontakte с помощью API, необходимо выполнить запрос POST /messages и заполнить в его теле следующие параметры:

from -  зарегистрированное имя отправителя, которое отображается клиенту при получении сообщения в поле "От кого". Зарегистрированное имя отправителя, которое используется в системе по умолчанию: TwinService;

templateName - название системного шаблона, который используется для создания шаблонов уведомлений в следующих мессенджерах (whatsapp, chat, vkontakte, odnoklassniki);

templateData - список переменных, которые будут использоваться в сообщениях. Данный параметр используется только для шаблона мессенджера WhatsApp. Значения задаются в формате JSON (название переменной - формат);

text - текст сообщения;

attachments - вложения (например, изображения, аудио-файлы, документы), которые можно переслать в сообщении клиенту при помощи Vkontakte. Ограничение: не более 10 вложений в сообщении. Значение параметра задается в следующем формате: "<type><[-]owner_id>_<media_id>, photo|video|audio|doc|wall|market|poll";

а также дополнительные параметры:

messaging.providers.mailru.service: "twin_important"
messaging.providers.mailru.application: "twin"
messaging.providers.mailru.signatureKey - 

Чат-сессии

На странице Настройки отображается список всех чатов, которые вы можете разместить на страницах вашего сайта или привязать к социальным сетям и/или сторонним сервисам при помощи API.

В верхней части страницы находится кнопка для создания нового чата.

Чуть ниже расположено поле поиска, при помощи которого вы можете быстро найти нужный чат. Для поиска чата введите в поле название чата или сценария, который в нем используется. Результаты поиска отображаются автоматически.

Под полем поиска отображается список всех созданных чатов. В правой части списка расположены кнопки, при помощи которых вы можете выполнить следующие действия:

• Получить кода фрейма;
• Подключить чат к социальной сети Facebook*;
• Посмотреть диалоги пользователей;
• Изменить свойства чата;
• Удалить чат.

Для создания нового чата выберите в боковом меню Чаты - Настройки и нажмите кнопку Новый чат.

Откроется следующее окно:

В поле Название введите название чата. По названию вы сможете найти чат в списке.

В поле Выберите сценарий укажите сценарий, который бот будет использовать в диалогах с пользователями.

В поле Время жизни сессии задайте продолжительность периода неактивности пользователя, по истечении которого диалог с пользователем будет завершен. Период неактивности задается в секундах.

В поле Сценарий, когда операторы не в сети, выберите сценарий, который будет использовать робот, если оператор не в сети.

В поле Текст, когда операторы заняты введите текст сообщения, которое робот будет отправлять пользователю, если согласно сценарию диалог нужно перевести на оператора, но все операторы заняты и никто не может ответить.

Если по окончании сессии требуется запросить у пользователя отзыв о диалоге, установите соответствующий флажок. В поле ниже укажите период времени с начала диалога, по завершении которого система запросит у пользователя отзыв.

В поле Тип отзыва выберите шкалу, по которой пользователь сможет оценить качество диалога. Для выбора доступны следующие варианты:

• 2-х бальная оценка;
• 5-ти бальная оценка;
• 10-ти бальная оценка.

В полях Цвет робота, Цвет оператора, Цвет пользователя, Цвет кнопок и Цвет текста кнопок при помощи палитры цветов выберите нужный цвет в диалоге. Для выбора цвета на палитре служат два горизонтальных ползунка. Вы также можете ввести RGBA, HSLA или HEX код цвета. Копки с пиктограммами стрелок вверх и вниз позволяют переключаться между соответствующими цветовыми моделями, а также отобразить поле для ввода HEX кода цвета.

В полях Аватар робота, Аватар оператора и Аватар чата можно загрузить изображения, которые система будет использовать в качестве аватаров. Вы можете загрузить изображения с расширением .jpeg и .png размером не более 5 МБ. Данные поля не являются обязательными. Если вы не загрузите изображения, система будет использовать изображения по умолчанию.

Установите флажок в поле Запросить результат диалога, чтобы по окончании диалога система запросила у пользователя результат.

В поле Через несколько секунд запросить отзыв о диалоге введите период времени в секундах с момента начала диалога, по завершению которого пользователю отобразится запрос с просьбой выполнить промежуточную оценку диалога.

Чтобы робот ответил на первое сообщение пользователя, установите в поле ниже соответствующий флажок.

В разделе Ссылки на мессенджеры можно указать ссылки на мессенджеры и социальные сети. Кнопки с пиктограммами указанных мессенджеров и социальных сетей будут отображаться рядом с кнопкой виджета. При нажатии на любую из этих кнопок пользователь сможет начать общение в любом из указанных вами мессенжеров или начать общение в виджете, а затем продолжить свой диалог в мессенджере или социальной сети.

Вы можете указать ссылки на следующие мессенджеры и социальные сети:

• Yandex Алиса;
• Facebook* messenger;
• Vkontakte;
• Whatsapp;
• Telegram;
• WeChat;
• Viber;
• Slack;
• Skype;
• Номер телефона (звонок боту на номер телефона);
• Одноклассники;
• Line Chat.

Чтобы сохранить изменения, нажмите кнопку Создать чат.

Теперь созданный пользователем чат появится в его личном кабинете.

Запуск чат-сессий через API

Чат-сессии запускаются через канал “chat” в теле запроса на отправку сообщений . 

Для этого нужно зайти на страницу https://tcl.twin24.ai/doc/notify/index.html и выполнить запрос POST /messages.

В теле запроса в канале chat заполнить следующие параметры:

chatId - идентификатор чата;

botId - идентификатор бота (для того, чтобы в чат-сессии с пользователем общался не тот бот, который привязан к чату, а другой бот, необходимо ввести botId нужного бота);

MessengerType - тип мессенджера, в который направляется чат-сессия. Если этот параметр не задан, чат-сессия направится в последний используемый мессенджер;

chatSessionName - название чат-сессии (любая строка на усмотрение пользователя - будет указана в отчете и при переводе на оператора);

Дополнительные параметры:

continueLastOrStartNewSession - продолжение последней чат-сессии либо начало новой (если задать значение true, сервис попытается продолжить открытую сессию, если таких нет - открывается новая, если значение false - сразу открывается новая чат-сессия).