Zenbot от JustAI

В инструкции описана процедура подключения робота, созданного в среде JustAI, через External Bot API к серверу Webim в качестве робота первой линии. В основе платформы Zenbot, которая реализует бота, лежат обучаемые нейронные сети.
  1. Зайдите в административный интерфейс робот-среды JustAI. У него существует отдельно prod-окружение и dev-окружение.
  2. управление проектами
  3. Выберите робота, которого будете подключать.
  4. обзор проекта
  5. Выберите "Создать канал". Откроется страница с каналами.
  6. каналы
  7. В разделе "Входящие каналы" нажмите "Добавить канал".
  8. Сгенерируйте уникальный токен при помощи какого-либо внешнего токенизатора. Например, можете использовать Online UUID Generator.
  9. Заполните все поля формы "Создание канала". В поле "Ветка" выберите значение "master", настройте выкатку автоматически и активируйте настройку мониторинга.
  10. создание канала
  11. Дождитесь деплоя сценария. В случае успеха его результат будет выглядеть примерно следующим образом: test.xml -> SUCCESS (0). (0ms) Tests took 0 ms Deployment of scenario 242-ozontravelchat-242-chT-1907039 was successful and took 2026ms
  12. В окне редактирования канала скопируйте поле API Endpoint.
  13. редактирование канала
  14. Откройте в административном интерфейсе Webim раздел "Отделы" и создайте там новый отдел для роботов.
  15. создание отдела
  16. В разделе "Операторы" создайте аккаунт оператора для робота и привяжите его к созданному на предыдущем шаге отделу.
  17. создание оператора 1
    создание оператора 2
  18. После сохранения оператора необходимо найти его идентификационный номер. Его можно посмотреть в URL-адресе страницы редактирования данного оператора. Пример URL: https://youraccount.webim.ru/agent/agents/206348/general ID оператора: 206348
  19. Зайдите в раздел Кнопки и размещения и создайте там новое размещение. Для него в поле "Обращение для отдела" выберите созданный вами отдел.
  20. Новое размещение
  21. Если Вы используете Webim версии 10.0 и выше, зайдите в раздел меню Боты и добавьте нового "умного" бота, используя External Bot API. Если Вы используете более старую версию Webim, то у Вас не будет соответствующего интерфейса для добавления бота. В таком случае это делается через редактирование системных параметров. Если у вас есть доступ к специальному меню редактирования системных параметров по специальному URL, то авторизуйтесь там и найдите параметр "robots". Если он пустой, добавьте туда настройки следующего формата:
    {   
       "id":{   
          "type": "bot_type",
          "api": "bot_url",
          "order": 1,
          "status": "bot_status"
       }
    }
    
    Описание параметров:
    Название параметра Тип Примеры Описание
    id unsigned int "185281" Идентификатор оператора, аккаунт которого будет использоваться для бота.
    bot_type enum, string При использовании версии Webim:
    • 9.1 — 'operator'
    • 9.2 — то 'q_a'
    • 10.0 — 'external_api'
    Тип робота. Здесь нет вариантов, тип всегда один, зависит только от используемой версии Webim.
    bot_url string Для dev-окружения: https://zenbot-dev.just-ai.com/chatadapter/ Для prod-окружения: https://zb04.just-ai.com/chatadapter/ Пример полного URL: https://zb04.just-ai.com/chatadapter/chatapi/webhook/incoming_webim/cde626a0-ab01-48c3-b552-481998efd270 URL сервера бота, на который должен обращаться сервер Webim. Он будет разным для разных окружений. Структура: BASE URL + method + token
    bot_status enum, string 'Online', чтобы бот был видим и чаты всегда назначались на него/ Статус оператора бота, который будет отображаться в системе.
    Пример:
    {   
       "185281":{   
          "type":"q_a",
          "api":"https://zb04.just-ai.com/chatadapter/chatapi/webhook/incoming_webim/cde626a0-ab01-48c3-b552-481998efd270",
          "order":1,
          "status":"online"
       }
    }
    
    Если доступа нет, обратитесь в техническую поддержку Webim.
  22. Обновить настройки, перейдя по ссылке: https://{account_name}.webim.ru/service/flush.php где account_name — имя Вашего аккаунта Webim.
  23. Для того, чтобы проверить функционирование бота, зайдите на Sample Page, которая доступна по следующему URL: https://{account_name}.webim.ru/sample-page.php
  24. Выберите размещение, которое Вы настроили в пункте 12, и нажмите кнопку начала чата.
  25. В открывшемся окне чата напишите первое сообщение.
  26. Чат должен будет назначиться на бота. Если он поймёт Ваше сообщение, то Вы получите ответ. Если нет, то при наличии живых операторов в статусе "Онлайн" в этом отделе диалог будет переведён на одного из них.
  27. zenbot
После этого бот готов к использованию.