Настройка канала Webim для бота Chatme.ai

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

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

Webim может использоваться:

• Как облачный сервис по подписке
• Как коробочное решение, развернутое на частных серверах клиента

Адрес аккаунта Webim используется для настройки подключения Агента в качестве бота-оператора — см. раздел Подключение ниже.

Форматы адреса аккаунта Webim:

Подключение

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

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

• Авторизуйтесь в Webim как администратор
• Перейдите в раздел Настройки → Боты

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

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

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

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

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

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

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

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

• Выберите 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

• Скопируйте ссылку из поля Chatbot webhook URL и вставьте её в поле Ссылка на внешний API в настройках бота в Webim

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

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

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

• Агент обучен
• Токен уникален
• Доступен адрес Канал Проекта
• Удастся зарегистрировать вебхук канала

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

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

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

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

• Чтобы отредактировать значение в любом поле, кликните по полю и впишите новое значение 
• Чтобы применить изменения к активированному Каналу Проекта, нажмите кнопку APPLY

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

• Агент обучен
• Токен уникален
• Доступен адрес Канал Проекта
• Удалось зарегистрировать вебхук канала

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

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

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

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

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

• Агент обучен
• Токен уникален
• Доступен адрес Канал Проекта
• Удалось зарегистрировать вебхук канала

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

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

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

​​​​​​​

Формат запроса на Webim (External Bot API 2.0) коннектор

Корректный запрос на “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.

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

Не поддерживается в текущей реализации функционала Платформы.
Предлагается выполнять перевод на оператора с помощью External Request, используя соответствующий метод Webim External Bot API 2.0.