Webim (External Bot API 2.0)
Last updated
Last updated
Webim – одна из популярных омниканальных платформ для общения с клиентами в текстовых каналах. Вы можете использовать ее в качестве канала для публикации вашего Агента в качестве бота-оператор. В данной статье рассмотрено подключение ботов через асинхронный API - Webim External Bot API 2.0Webim может использоваться как сервис по подписке на облаке, так и быть размещен на частных серверах клиента как коробочное решение. Адрес аккаунта Webim используется для настройки подключения Агента в качестве бота-оператора - см. Подключение
При использовании Webim как облачного сервиса по подписке адрес аккаунта Webim выглядит как <some-name>.webim.ru, где <some-name> - имя поддоммена, которые вы установите в настройках аккаунта Webim. Например, адрес может быть таким https://chatmeai006.webim.ru/
При размещении Webim на частных серверах клиента адрес аккаунта устанавливается клиентом и зависит от домена размещения.
В первую очередь нужно произвести конфигурацию на стороне Webim.
Авторизуйтесь в Webim как администратор.
Перейдите в раздел Настройки → Боты.
Начните создавать нового бота и заполните следующие поля:
Оператор для бота — выберите оператора, к которому будет прикреплен бот, рекомендуется создавать отдельных операторов для ботов
Тип бота — выберите Умный бот
Порядок сортировки — порядок определяет, на каком месте в списке ботов данный бот будет находиться. Чем меньше число, тем выше приоритет
Статус — выберите статус бота
Версия — выберите версию 2
Ссылка на внешний API — введите адрес вебхука, его можно получить при настройке Канал Проекта — см. 2. Конфигурация агента в Платформа - п.2.4
Установите ссылку на вебхук, полученную при конфигурации канала агента в Платформе в поле Ссылка на внешний API, сохраните бота и получите токен авторизации. Используйте токен для завершения конфигурации канала агента с п.2.5
На этом конфигурация бота в Webim завершена.
Агенту необходимо создать и настроить Канал Проекта с Коннектором “Webim (External Bot API 2.0)”.
Кликните по кнопке настроек Агента.
Нажмите кнопку Add channel.
Выберите Webim (External Bot API 2.0).
Канал Проекта будет сохранен и активирован, если:
Агент обучен;
токен в поле Webim (External Bot API 2.0) token token уникален (нет ли активных Канал Проекта того же типа с тем же значением в поле);
будет доступен адрес Канал Проекта;
удастся зарегистрировать вебхук канала.
Канал Проекта будет сохранен, но не активирован, если одно или больше условий не будут выполнены.
Чтобы отредактировать значение в любом поле, кликните по полю и впишите новое значение.
Изменения будут применены, если:
Агент обучен;
токен в поле Webim (External Bot API 2.0) token уникален (нет ли активных Канал Проекта того же типа с тем же значением в поле);
будет доступен адрес Канал Проекта;
удастся зарегистрировать вебхук канала.
Изменения не будут применены, если одно или больше условий не будут выполнены.
Изменения будут применены и Канал Проекта будет активирован, если:
Агент обучен;
токен в поле Webim (External Bot API 2.0) token уникален (нет ли активных Канал Проекта того же типа с тем же значением в поле);
будет доступен адрес Канал Проекта;
удастся зарегистрировать вебхук канала.
Изменения будут применены, но Канал Проекта не будет активирован, если одно или больше условий не будут выполнены.
Корректный запрос на “Omnichannel” Коннектор имеет следующий формат:
visitor — опциональное поле.
Взаимодействие с Webim происходит через Webim External Bot API 2.0 и согласно настройкам вашего аккаунта Webim. Агент является ботом-оператором в Webim.
Да
формат <webim chat_id>|omnichannel т.к. используется Коннектор Omnichannel
Да
Да
нажатие на кнопку приходит как текст лейбла кнопкиВ WhatsApp через Webim: если бот отправил собеседнику кнопки, то Webim преобразует их в нумерованный список и обработает только ввод номера элемента, ввод лейбла кнопки или другого текста не будет обработан - Webim не будет воспринимать другие символы\текст
Нет
Не поддерживается перевод на оператора через слот Change Chat Mode в текущей реализации функционала Платформа. Перевод на оператора можно сделать “вручную” через External Request
Не поддерживается в текущей реализации функционала Платформа.Предлагается выполнять перевод на оператора с помощью External Request, используя соответствующий метод Webim External Bot API 2.0
Откроется панель выбора Конечный канал.
Откроется панель создания Канал Проекта.
По необходимости пропишите заголовок для данного Канал Проекта в поле названия с плейсхолдером New channel.
Пропишите адрес Webim External Bot API 2.0 для вашего аккаунта в поле Webim (External Bot API 2.0) webhook URL в виде https://<some-name>.webim.ru/api/bot/v2 где <some-name> - имя поддоммена, которые вы установите в настройках аккаунта Webim.
Установите полученный в настройках бота Webim токен в поле Webim (External Bot API 2.0) token.
Cсылку на вебхук Канал Проекта (поле Chatbot webhook URL) скопируйте и вставьте в поле Ссылка на внешний API в настройках бота в Webim.
Для сохранения Канал Проекта без его активации, нажмите кнопку CREATE.
Для сохранения и активации Канал Проекта, нажмите кнопку CREATE & ACTIVATE.
Для отмены создания Канал Проекта нажмите кнопку CANCEL.
Для редактирования Канал Проекта, необходимо кликнуть по его иконке на карточке Агента.
Чтобы применить изменения к активированному Канал Проекта, нажмите кнопку APPLY.
Чтобы деактивировать Канал Проекта, нажмите кнопку DEACTIVATE.
Чтобы применить изменения к деактивированному Канал Проекта, нажмите кнопку SAVE.
Чтобы применить изменения и активировать Канал Проекта, нажмите кнопку SAVE & ACTIVATE.
Чтобы отменить внесение изменений, нажмите кнопку CANCEL.
Чтобы удалить Канал Проекта, нажмите кнопку DELETE.