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

@Агент⁠

а в качестве бота-оператор. В данной статье рассмотрено подключение ботов через асинхронный API -

Webim External Bot API 2.0⁠

⁠

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

@Агент⁠

а в качестве бота-оператора - см.

Подключение⁠

⁠

При использовании Webim как облачного сервиса по подписке адрес аккаунта Webim выглядит как <some-name>.webim.ru, где <some-name> - имя поддоммена, которые вы установите в настройках аккаунта Webim. Например, адрес может быть таким

https://chatmeai006.webim.ru/⁠

⁠

При размещении Webim на частных серверах клиента адрес аккаунта устанавливается клиентом и зависит от домена размещения.

Подключение

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

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

Авторизуйтесь в

Webim⁠

как администратор.

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

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

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

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

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

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

Версия — выберите версию 2

Ссылка на внешний API — введите адрес вебхука, его можно получить при настройке

@Канал Агента⁠

— см.

2. Конфигурация агента в Платформа⁠

п.2.4⁠

⁠

Установите ссылку на вебхук, полученную при

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

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

п.2.5⁠

⁠

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

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

⁠

@Агент⁠

у необходимо создать и настроить

@Канал Агента⁠

@Коннектор⁠

ом “Omnichannel”.

Войдите в меню редактирования (Edit) настроек вашего

@Агент⁠

⁠

В появившемся окне перейдите на вкладку Channels для настройки каналов, затем:

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

Нажмите кнопку Add channel

⁠

Интеграция с

Webim External Bot API 2.0⁠

происходит через универсальный

@Коннектор⁠

с названием “Omnichannel”, установите его в поле Channel.

⁠

По необходимости пропишите заголовок для данного

@Канал Агента⁠

в поле Title.

⁠

После выбора “Omnichannel” вам станет доступна ссылка на вебхук канала агента (поле Chatbot webhook: URL), которую нужно скопировать и вставить в поле

Ссылка на внешний API⁠

в настройках бота в Webim -

п.1.4⁠

⁠

⁠

Установите полученный в настройках бота Webim токен в поле Channel webhook: Token в окне настроек

@Канал Агента⁠

Также пропишите адрес

Webim External Bot API 2.0⁠

для вашего аккаунта в поле Channel webhook: URL в виде https://<some-name>.webim.ru/api/bot/v2 где <some-name> - имя поддоммена, которые вы установите в настройках аккаунта Webim.

⁠

⁠

Активируйте канал переключением тумблера для того, чтобы

@Агент⁠

начал отвечать в нем.

⁠

Если

@Агент⁠

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

@Агент⁠

а, после чего повторить попытку активации

@Канал Агента⁠

⁠

После активации

@Канал Агента⁠

, если есть проблемы с его доступностью, будет выведено предупреждение (

@Канал Агента⁠

будет активирован несмотря на проблемы):

"Can’t reach channel" — выводится в случае, если сервер не отвечает по указанному URL

⁠

Сохраните

@Канал Агента⁠

— нажмите Save.

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

Формат запроса на Omnichannel коннектор

Корректный запрос на “Omnichannel”

@Коннектор⁠

имеет следующий формат:

{

"event": "new_message",

"chat_id": "12345",

"message": {

"kind": "visitor",

"text": "hello!"

"visitor": {

"id": 123,

"fields": {

"name": "John"

}

visitor — опциональное поле.

Общение

Взаимодействие с Webim происходит через

Webim External Bot API 2.0⁠

и согласно настройкам вашего аккаунта Webim.

@Агент⁠

является ботом-оператором в Webim.

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

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

Канальная переменная

Конечный канал

Переменная в теле входящего запроса из канала

channel_conversation_id

Webim (External bot API 2.0)

chat.id

channel_visitor_id

Webim (External bot API 2.0)

visitor.id

channel_visitor_firstname

Webim (External bot API 2.0)

visitor.fields.name

channel_visitor_lastname

Webim (External bot API 2.0)

нет

channel_visitor_account

Webim (External bot API 2.0)

visitor.fields.login

channel_visitor_phone

Webim (External bot API 2.0)

visitor.fields.phone

channel_visitor_email

Webim (External bot API 2.0)

visitor.fields.email

channel_visitor_source

Webim (External bot API 2.0)

visitor.fields.site

channel_reply_to

Webim (External bot API 2.0)

нет

There are no rows in this table

⁠

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

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

Функционал

Конечный канал

Наличие в канале

Описание

channel_chat_id

Webim (External bot API 2.0)

Да

формат <webim chat_id>|omnichannel т.к. используется

@Коннектор

⁠

@Webim (External bot API 2.0)

⁠

Сообщения дойдут до собеседника, если агент напишет первый в существующем чате

Webim (External bot API 2.0)

Да

Кнопки

Webim (External bot API 2.0)

Да

нажатие на кнопку приходит как текст лейбла кнопки

В WhatsApp через Webim: если бот отправил собеседнику кнопки, то Webim преобразует их в нумерованный список и обработает только ввод номера элемента, ввод лейбла кнопки или другого текста не будет обработан - Webim не будет воспринимать другие символы\текст

Перевод на оператора

Webim (External bot API 2.0)

Нет

Не поддерживается перевод на оператора через слот

Change Chat Mode

⁠

в текущей реализации функционала

@Платформа

⁠

. Перевод на оператора можно сделать “вручную” через

External Request

⁠