chatme.ai
Search…
Создание Агента на платформе
ДЛЯ РАЗРАБОТЧИКОВ
Асинхронный Webim 2.0
В данной статье описан вывод Агента в каналы через асинхронный Webim 2.0 и возможности общения Агента в каналах при выводе через асинхронный Webim 2.0.
Webim — одна из популярных омниканальных платформ для общения с клиентами в текстовых каналах.
В данной статье рассмотрено подключение Агентов через асинхронный API – Webim External Bot API 2.0.
Webim может использоваться как сервис по подписке на облаке, так и быть размещен на частных серверах как коробочное решение. Адрес аккаунта Webim используется для настройки подключения Агента в качестве бота-оператора – см. раздел Подключение.
  • При использовании Webim как облачного сервиса по подписке адрес аккаунта Webim выглядит как <some-name>.webim.ru, где <some-name> – имя под-домена, которые установленный в настройках аккаунта Webim. Например, адрес может быть задан следующим образом: https://chatmeai006.webim.ru/.
  • При размещении Webim на частных серверах клиента адрес аккаунта устанавливается клиентом и зависит от домена размещения.

Подключение

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

В первую очередь необходимо произвести конфигурацию на стороне Webim.
  1. 1.
    Авторизуйтесь в Webim как администратор.
  2. 2.
    Перейдите в раздел НастройкиБоты.
  3. 3.
    Начните создавать нового бота и заполните следующие поля:
    • Оператор для бота — выберите оператора, к которому будет прикреплен бот. Для ботов рекомендуется создавать отдельных операторов.
    • Тип бота — выберите Умный бот.
    • Порядок сортировки — порядок определяет, на каком месте в списке ботов данный бот будет находиться. Чем меньше число, тем выше приоритет.
    • Статус — выберите статус бота.
    • Версия выберите версию 2.
    • Ссылка на внешний API — введите адрес вебхука, его можно получить при настройке Канал Агента - см. ниже раздел Конфигурация канала бота на Платформе.
  4. 4.
    Установите ссылку на вебхук, полученную при конфигурации канала агента в Платформе (см. раздел ниже) в поле Ссылка на внешний API, сохраните бота и получите токен авторизации. Используйте токен для завершения конфигурации канала агента с п. 2.5 ниже.
На этом конфигурация бота в Webim завершена.

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

Для Агента необходимо создать и настроить Канал Агента с коннектором Omnichannel.
  1. 1.
    Войдите в меню редактирования (Edit) настроек вашего Агента.
  2. 2.
    В появившемся окне перейдите на вкладку Channels для настройки каналов, далее:
    1. 1.
      выберите тип канала Omnichannel
    2. 2.
      Нажмите кнопку Add another channel
  3. 3.
    В поле Channel выберите Omnichannel (не Webim – канал Webim для синхронного API). Интеграция с Webim External Bot API 2.0 происходит через универсальный Коннектор с названием Omnichannel (Webim2.0 коннектор полностью удовлетворяет требованиям Webim External Bot API 2.0).
  4. 4.
    После выбора Omnichannel станет доступна ссылка на вебхук канала агента (поле Chatme webhook: URL). Скопируйте это значение и вставьте в поле Ссылка на внешний API в настройках бота в Webim – п.1 Конфигурация бота на стороне Webim.
  5. 5.
    Установите полученный в настройках бота Webim токен в поле Channel webhook: Token в окне настроек Канала Бота. Также пропишите адрес Webim External Bot API 2.0 для вашего аккаунта в поле Channel webhook: URL в виде https://<some-name>.webim.ru/api/bot/v2/, где <some-name> – имя под-домена, установленное в настройках аккаунта Webim.
  6. 6.
    Активируйте канал переключением тумблера, для того чтобы Бот начал отвечать в настроенном Канале.
    1. 1.
      Если Агент не был обучен, появится предупреждение. В таком случае необходимо обучить Агента, после чего повторить попытку активации Канал Агента.
  7. 7.
    После активации Канала Агента, если есть проблемы с его доступностью, будет выведено предупреждение (Канал будет активирован несмотря на проблемы): "Can’t reach channel" — выводится в случае, если сервер не отвечает по указанному URL
  8. 8.
    Нажмите Save, чтобы сохранить Канал.
Все настройки будут применены только после сохранения.

Общение

Взаимодействие с Webim происходит через Webim External Bot API 2.0 и согласно настройкам вашего аккаунта Webim. Бот является ботом-оператором в Webim.

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

Канальная переменная
Переменная в теле входящего запроса из канала
channel_conversation_id
chat.id
channel_visitor_id
visitor.id
channel_visitor_firstname
visitor.fields.name
channel_visitor_lastname
channel_visitor_account
visitor.fields.login
channel_visitor_phone
visitor.fields.phone
channel_visitor_email
visitor.fields.email
channel_visitor_source
visitor.fields.site

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

Функционал
Доступность
Описание
Переменная channel_chat_id
Да
Формат <webim chat_id>|omnichannel т.к. используется Коннектор Webim2.0
Агент может писать первым
Да
Кнопки
Да
Нажатие на кнопку приходит как текст лейбла кнопки
Перевод на оператора
Нет
Не поддерживается в текущей реализации функционала Платформа.
Передача файлов в виде файлов от Агента (слот Attachment)
Нет
Передача файлов в виде ссылок от Агента (слот Attachment)
Да
Получение файла от Собеседника в сценарий
Да
Доставка сообщений более 1000 символов от Агента до Собеседника
Да
Использование маркдауна
Нет

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

Не поддерживается для асинхронного API Webim в текущей реализации функционала Платформы.
Предлагается выполнять перевод на оператора с помощью External Request, используя соответствующий метод Webim External Bot API 2.0.
Copy link
On this page
Подключение
Конфигурация на стороне Webim
Конфигурация канала Агента в Платформе
Общение
Маппинг канальных переменных из канала Webim2.0
Возможности общения в канале Webim2.0
Перевод на оператора