Функции сервиса уведомлений

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

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

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

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

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

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

Отправка уведомлений при помощи заданий

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

1. Откройте вкладку Уведомления – Задания на отправку и нажмите кнопку Добавление нового задания на отправку сообщений.
   
   
   
   
   
2. Введите наименование задания в соответствующее поле и скачайте шаблон нужного типа уведомления. Для скачивания шаблона нажмите на выделенный текст.
   
   
   
   
   
3. Откройте загруженный шаблон и заполните его согласно таблице описания полей.
   
   
4. Нажмите кнопку Выберите файл, чтобы загрузить заполненный шаблон. Установите Ограничитель по времени отправки текстовых сообщений и нажмите кнопку Создать.
   
   

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

Запуск отправки сообщений

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

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

Чтобы отправить уведомление через API, выполните следующие действия:

1. Откройте TWIN API. Там найдите метод Create message batch.
    
   
   
2. В поле Bearer введите ваш авторизационный токен.
   
   
   

   Информация
   title Инструкция по получению авторизационного токена
   Чтобы получить авторизационный токен, откройте вкладку Помощь – API и скопируйте оттуда ваш токен.

   
   
   
3. Нажмите ADD OBJECT в пункте messages.
   
   
   
   
4. Если вы хотите использовать шаблон уведомления, то введите идентификатор шаблона в поле templateId.
   
   
   

   Информация
   title Инструкция по получению идентификатора шаблона
   Чтобы получить идентификатор шаблона, откройте Уведомления – Шаблоны и скопируйте идентификатор нужного шаблона.

   
   
   
5. Нажмите ADD OBJECT в пункте destinations.
   
   
   
   
6. Введите номер телефона, на который хотите отправить уведомление в поле phone.
   
   
   
   
7. Нажмите CHANNELS OBJECT в пункте channels.
   
   
   
   
8. Нажмите на интересующие вас каналы связи.
   
   
   
   
9. Если вы не использовали шаблон, то заполните поле text.
   

   Примечание
   Если вы использовали шаблон, то поле text будет проигнорировано.

   
   
   
   
10. Заполните поле from. Туда нужно ввести имя отправителя, от лица которого будут рассылаться уведомления. 
    

    Примечание
    Если у вас нет собственного имени отправителя, то используйте TwinService.

    
    
    
    
11. Нажмите кнопку Try It. 
    
    
    
    

После этого убедитесь, что все прошло успешно. Для этого проверьте поле RESPONSE, там должно быть значение 201. Также результат можно увидеть в поле YOUR REQUEST HISTORY.

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

Для того, чтобы Чтобы отправить сообщение в Telegram через API, нужно добавить Telegram-бота.

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

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

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

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

Image Removed

{
	"messages": {
		"destinations": [
			{
				"clientId": "87ae9aac-bdf5-4992-b2f8-71e6f73be10a"
			}
		],
		"channels": {
			"chat": {
				"chatId": "096555f5-948b-422f-b70e-12218c6f1581",
				"messengerType": "TELEGRAM",
				"provider": "TWIN"
			}
		}
	}
}

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

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

Image Removed

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

Image Removed

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

Image Removed

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

Отправка уведомлений через разные каналы

Отправка через WhatsApp

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

Image Removed

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

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

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

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

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

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

Примечание: если пользователь не отвечал на сообщения бота в WhatsApp в течение 24 часов, бот не может отправлять ему сообщения. Если пользователь отвечает, бот может продолжать отправлять сообщения в течение следующих 24 часов с момента последнего сообщения. Для того, чтобы бот снова мог отправлять сообщения пользователю, необходим согласованный с WhatsApp шаблон, который предоставляется техподдержкой сервиса TWIN.

1. .
   

   Подсказка
   Как привязать бота к чату описано в этой статье.

   
   

После привязки бота к чату нужно написать боту команду /start для начала чат-сессии.

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

Отправка через 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

Image Added

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

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 и нажать Новый шаблон.

Image Added

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

Image Added

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 и заполнить в его теле следующие параметры:

Отправка через Vkontakte

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

Image Removed

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

Image Removed

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 и заполнить в его теле следующие параметры:

"vkontakte": {
	"from": "string",
	"templateName": "string",
	"templateData": [
		"string"
	],
	"text": "string",
	"provider": "APN",
	"attachments": [
		"video-85635407_165186811",
		"wall-92255884_16"
	]
}

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.

Image Removed

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

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

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

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

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

Image Removed

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

Image Removed

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

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

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

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

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

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

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

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

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

Image Removed

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

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

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

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

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

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

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

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

при помощи API.

Image Added

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

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

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

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

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

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

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

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

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

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

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

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

"chat": {
	"chatId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
 	"botId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
 	"messengerType": "WHATSAPP",
 	"chatSessionName": "string",
 	"provider": "APN",
 	"continueLastOrStartNewSession": true     
}

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

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