Вывод Агента в каналы через Webim

В данной статье описан вывод Агента в каналы через Webim и возможности общения Агента в каналах при выводе через Webim.

Webim — одна из популярных омниканальных платформ для общения с клиентами в текстовых каналах. Используя омниканальную платформу Webim, можно разместить Агент в одном или нескольких каналах общения. Webim имеет два API для работы с Агентами — синхронный (описан в данной статье) и асинхронный (см. Асинхронный Webim 2.0). Взаимодействие с конечным каналом “Webim” происходит в синхронном режим, с использованием Webim External Bot API 1.0.

Подключение

Конфигурация на стороне Webim

В первую очередь нужно произвести конфигурацию на стороне Webim.

1. Авторизуйтесь в Webim как администратор.

2. Перейдите в раздел Настройки → Боты.

3. Начните создавать нового бота и заполните следующие поля:

   • Оператор для бота — выберите оператора, к которому будет прикреплен бот, рекомендуется создавать отдельных операторов для ботов.

   • Тип бота — выберите Умный бот.

   • Порядок сортировки — порядок определяет, на каком месте в списке ботов данный бот будет находиться. Чем меньше число, тем выше приоритет.

   • Статус — выберите статус бота.

   • Версия — выберите версию 1.

   • Ссылка на внешний API — введите адрес вебхука, его можно получить при настройке канала Агента - см. п.2 раздела Конфигурация канала агента в Платформе.

На этом конфигурация бота в Webim завершена.

Конфигурация канала Агента в Платформе

Агенту необходимо создать и настроить канал Агента с коннектором Webim.

1. Войдите в меню редактирования (Edit) настроек вашего Агента.
2. В появившемся окне перейдите на вкладку Channels для настройки каналов, далее:

   1. выберите тип канала Omnichannel

   2. Нажмите кнопку Add another channel
3. Интеграция с Webim происходит через универсальный Коннектор с названием “Webim”, установите его в поле Channel.
4. По необходимости пропишите заголовок для данного канала в поле Title.

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

5. После выбора Webim вам станет доступна ссылка на вебхук канала агента (поле Chatme webhook: URL), которую нужно скопировать и вставить в поле Ссылка на внешний API в настройках бота в Webim.
6. Активируйте канал переключением тумблера для того, чтобы Агент начал отвечать в нем после сохранения.

   1. Если Агент не был обучен, появится предупреждение. В таком случае необходимо обучить Агента, после чего повторить попытку активации Канал Агента.
7. После активации Канала Агента, если есть проблемы с его доступностью, будет выведено предупреждение (Канал будет активирован несмотря на проблемы): "Can’t reach channel" — выводится в случае, если сервер не отвечает по указанному URL
8. Сохраните Канал Агента — нажмите Save.

Все настройки будут применены только после сохранения.

Общение

Взаимодействие с данным конечным каналом происходит по синхронному методу, с использованием Webim External Bot API 1.0. Так как конечный канал синхронный, то общение происходит по схеме Request от Webim — Response от Агента, что накладывает некоторые ограничения и особенности на общение:

1. Чтобы перевести на оператора с помощью Change Chat Mode, Change Chat Mode должен стоять обязательно после слота Wait For Reaction: в ответ на Response c сообщением собеседника будет отправлен Response c управляющей командой перевода диалога на оператора

2. Агент может только отвечать на сообщения, но не может первым отправлять сообщения в Чат данного конечного канала через слот Timer или Incoming Request, так как в этом случае от Webim не будет Request, на который можно дать Response.

Важно: при срабатывании Incoming Request или Timer Агент начнет соответствующие ветки Сценария и пойдет по Сценарию, остановившись на слоте ожидания ввода, при этом, отправленные до этого слота сообщения фактически не будут доставлены Собеседнику.

Маппинг Канальных переменных из канала Webim

Канальная переменная	Переменная в теле входящего запроса из канала
channel_conversation_id	chat.id
channel_visitor_id	visitor.id
channel_visitor_firstname	visitor.firstname
channel_visitor_lastname	visitor.lastname
channel_visitor_account	visitor.username
channel_visitor_phone	visitor.phone
channel_visitor_email	visitor.email
channel_visitor_location	visitor.location

Возможности общения в канале Webim

Функционал	Наличие в канале	Описание
Передача файлов в виде файлов от Агента (слот Attachment)	Да
Переменная channel_chat_id	Да	формат <webim chat_id>|webim
Сообщения дойдут до собеседника, если агент напишет первый в существующем чате	Частично	Диалог в Webim длится 24 часа, сообщения дойдут до Собеседника только в течение этого времени
Перевод на оператора	Да	C помощью слота Change Chat Mode Важно: перед Change Chat Mode обязательно должен находиться Wait For Reaction. Перевод на оператора также произойдет автоматически, если Webim не получит ответа от Агента в течение 5 секунд.
Кнопки	Да
Передача файлов в виде ссылок от Агента (слот Attachment)	Да
Передача файлов в (слот Attachment)	Нет	Слот Attachment передаст текстовую ссылку
Получение файла от Собеседника в сценарий	Нет
Получение геолокации от собеседника в сценарии	Да	В переменную client_message будет передана ссылка вида: https://www.google.com/maps/search/?api=1&query=62.174535,-75.937498
Доставка сообщений более 1000 символов от Агента до Собеседника	Да
Использование маркдауна	Нет