Webim (External Bot API 1.0)

Webim — одна из популярных омниканальных платформ для общения с клиентами в текстовых каналах. Используя омниканальную платформу Webim, можно разместить Бота в одном или нескольких каналах общения.

Подключение

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

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

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

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

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

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

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

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

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

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

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

5. 

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

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

Агенту необходимо создать и настроить Канал Проекта с Коннектором “Webim (External Bot API 1.0)”.

1. Кликните по кнопке настроек Агента.

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

3. Откроется панель выбора Конечный канал.

4. Выберите Webim (External Bot API 1.0).

5. Откроется панель создания Канал Проекта.

6. По необходимости пропишите заголовок для данного Канал Проекта в поле названия с плейсхолдером New channel.

7. Cсылку на вебхук Канал Проекта (поле Chatbot webhook URL) скопируйте и вставьте в поле Ссылка на внешний API в настройках бота в Webim.

8. Для сохранения Канал Проекта без его активации, нажмите кнопку CREATE.

9. Для сохранения и активации Канал Проекта, нажмите кнопку CREATE & ACTIVATE.

10. 1. Канал Проекта будет сохранен и активирован, если:

    2. 1. Агент обучен;

       2. будет доступен адрес Канал Проекта;

       3. удастся зарегистрировать вебхук канала.

    3. Канал Проекта будет сохранен, но не активирован, если одно или больше условий не будут выполнены.

11. Для отмены создания Канал Проекта нажмите кнопку CANCEL.

Редактирование и удаление Канала Агента

Для редактирования Канал Проекта, необходимо кликнуть по его иконке на карточке Агента.

1. Чтобы отредактировать значение в любом поле, кликните по полю и впишите новое значение.

2. Чтобы применить изменения к активированному Канал Проекта, нажмите кнопку APPLY.

3. 1. Изменения будут применены, если:

   2. 1. Агент обучен;

      2. будет доступен адрес Канал Проекта;

      3. удастся зарегистрировать вебхук канала.

   3. Изменения не будут применены, если одно или больше условий не будут выполнены.

4. Чтобы деактивировать Канал Проекта, нажмите кнопку DEACTIVATE.

5. Чтобы применить изменения к деактивированному Канал Проекта, нажмите кнопку SAVE.

6. Чтобы применить изменения и активировать Канал Проекта, нажмите кнопку SAVE & ACTIVATE.

7. 1. Изменения будут применены и Канал Проекта будет активирован, если:

   2. 1. Агент обучен;

      2. будет доступен адрес Канал Проекта;

      3. удастся зарегистрировать вебхук канала.

   3. Изменения будут применены, но Канал Проекта не будет активирован, если одно или больше условий не будут выполнены.

8. Чтобы отменить внесение изменений, нажмите кнопку CANCEL.

9. Чтобы удалить Канал Проекта, нажмите кнопку DELETE.

Общение

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

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

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

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

Переменная	Конечный канал	Переменная в запросе из канала
channel_conversation_id	Webim (External Bot API 1.0)	chat.id
channel_visitor_id	Webim (External Bot API 1.0)	visitor.id
channel_visitor_firstname	Webim (External Bot API 1.0)	visitor.firstname
channel_visitor_lastname	Webim (External Bot API 1.0)	visitor.lastname
channel_visitor_account	Webim (External Bot API 1.0)	visitor.username
channel_visitor_phone	Webim (External Bot API 1.0)	visitor.phone
channel_visitor_email	Webim (External Bot API 1.0)	visitor.email
channel_visitor_location	Webim (External Bot API 1.0)	visitor.location

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

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

При использовании Слота Change Chat Mode происходит переключение на оператора.Чтобы перевести на оператора с помощью Change Chat Mode, этот Слот должен стоять обязательно после Слота Wait For Reaction. После переключения на оператора диалог завершается и отображается на странице Аналитики (Вкладка Аналитики).

Переключение на оператора при отсутствии ответа от Агента

При возникновении какой-либо ошибки запроса к API (ответ отличается от ожидаемого или запрос закрылся по таймауту 5 сек) чат автоматически переводится в общую очередь операторов.