Перейти к основному содержимому

Webim (External Bot API 2.0)

подсказка
Webim — платформа онлайн-консультирования. Общение возможно через различные каналы: чат на сайте, мессенджеры, социальные сети, чат-боты, мобильные приложения и другие. Платформа также интегрируется с CRM и HelpDesk системами.

Webim в JAICP вы можете подключить как входящий или операторский канал. В этой статье мы рассматриваем подключение канала Webim (External Bot API 2.0). Для данного канала подключение ботов происходит посредством External Bot API 2.0.

Настройка Webim (External Bot API 2.0)​

Авторизуйтесь в платформе Webim как администратор. На панели управления нажмите Настройки → Боты.

Приступите к созданию нового бота, заполните поля:

  • Оператор для бота — выберите оператора, к которому будет прикреплён бот. Рекомендуется создавать для ботов отдельных операторов.
  • Тип бота — выберите Умный бот
  • Порядок сортировки — порядок определяет, на каком месте в списке ботов данный бот будет находиться. Чем меньше число, тем выше приоритет.
  • Статус — выберите статус бота.
  • Версия — выберите версию 2.
  • Ссылка на внешний API — в качестве ссылки на внешний API укажите https://example.com. После подключения канала в JAICP необходимо будет заменить эту ссылку.

Нажмите Сохранить. Скопируйте токен авторизации, он понадобится на этапе созданий канала в JAICP.

подсказка
Подробнее о методах Webim (External Bot API 2.0)

Создание канала​

Нажмите на панели управления Каналы → Входящие → Подключить канал. В разделе Другие выберите Webim (External Bot API 2.0).

Заполните поля:

  • Название — укажите название для канала или оставьте по умолчанию.
  • Токен — вставьте скопированный ранее токен.
  • Почтовый адрес — укажите почтовый адрес учетной записи администратора сервиса Webim.
  • Пароль — укажите пароль учетной записи администратора сервиса Webim.
подсказка
Указание данных учетной записи администратора необходимо только для получения списка операторов.
  • Домен — введите домен, на который вы устанавливаете сервис Webim. Например, для учетной записи https://examplecom.webim.ru домен examplecom.
  • Отправлять ли /start в начале диалога — при активном параметре бот начинает диалог, не дожидаясь сообщения от клиента.
  • Ветка — укажите ветку проекта, которую вы хотите развернуть в канал, по умолчанию master. Вы также можете выбрать Git-тег или ввести хеш конкретного коммита.
  • Публикация — автоматически (после каждого сохранения внесенных в проект изменений) или вручную (с помощью кнопки Опубликовать в строке с описанием канала).
предупреждение
Публикацию сценария нужно выполнять перед запуском бота. На этом этапе происходит сборка бота, проверка синтаксиса сценариев и скриптов, а также проверка прохождения тестов.

Нажмите Создать. Дождитесь всплывающего окна с результатом публикации.

После создания канала формируется API Endpoint, перейдите к редактированию канала и скопируйте значение поля API Endpoint. Вернитесь в Webim, перейдите к редактированию бота. Замените здесь значение поля Ссылка на внешний API на скопированный API Endpoint.

Тестирование бота​

Перейдите в окно диалога с ботом в подключенном мессенджере и отправьте ему приветственную/активационную фразу, предусмотренную вашим сценарием. После этого должен начаться ваш диалог с ботом.