Webim (External Bot API 1.0)
Last updated
Last updated
Webim — одна из популярных омниканальных платформ для общения с клиентами в текстовых каналах. Используя омниканальную платформу Webim, можно разместить Бота в одном или нескольких каналах общения.
В первую очередь нужно произвести конфигурацию на стороне Webim.
Авторизуйтесь в Webim как администратор.
Перейдите в раздел Настройки → Боты.
Начните создавать нового бота и заполните следующие поля:
Оператор для бота — выберите оператора, к которому будет прикреплен бот, рекомендуется создавать отдельных операторов для ботов.
Тип бота — выберите Умный бот.
Порядок сортировки — порядок определяет, на каком месте в списке ботов данный бот будет находиться. Чем меньше число, тем выше приоритет.
Статус — выберите статус бота.
Версия — выберите версию 1.
Ссылка на внешний API — введите адрес вебхука, его можно получить при настройке Канал Проекта — см. п.2 Конфигурация канала агента в Платформе.
На этом конфигурация бота в Webim завершена.
Агенту необходимо создать и настроить Канал Проекта с Коннектором “Webim (External Bot API 1.0)”.
Кликните по кнопке настроек Агента.
Нажмите кнопку Add channel.
Выберите Webim (External Bot API 1.0).
Канал Проекта будет сохранен и активирован, если:
Агент обучен;
будет доступен адрес Канал Проекта;
удастся зарегистрировать вебхук канала.
Канал Проекта будет сохранен, но не активирован, если одно или больше условий не будут выполнены.
Чтобы отредактировать значение в любом поле, кликните по полю и впишите новое значение.
Изменения будут применены, если:
Агент обучен;
будет доступен адрес Канал Проекта;
удастся зарегистрировать вебхук канала.
Изменения не будут применены, если одно или больше условий не будут выполнены.
Изменения будут применены и Канал Проекта будет активирован, если:
Агент обучен;
будет доступен адрес Канал Проекта;
удастся зарегистрировать вебхук канала.
Изменения будут применены, но Канал Проекта не будет активирован, если одно или больше условий не будут выполнены.
Взаимодействие с данным Конечный канал происходит по синхронному методу, с использованием Webim External Bot API 1.0.Так как Конечный канал синхронный, то Общение происходит по схеме Request от Webim — Response от Агента, это накладывает некоторые ограничения и особенности на Общение:
Чтобы перевести на оператора с помощью Change Chat Mode, этот Слот должен стоять обязательно после Слота Wait For Reaction: в ответ на Response c сообщением Собеседника будет отправлен Response c управляющей командой перевода диалога на оператора
Агент может только отвечать на сообщения, но не может первым отправлять сообщения в Чат данного Конечный канал через Слот Timer или Incoming Request, так как в этом случае от Webim не будет Request, на который можно дать Response.
Важно: при срабатывании Timer или Incoming Request Агент начнет соответствующие Ветка сценария и пойдет по Сценарий агента, остановившись на Слот ожидания ввода, при этом, отправленные до этого Слота сообщения фактически не будут доставлены Агенту.
Нет
Сообщения не дойдут до Собеседника в таком случае. До Собеседника дойдут только сообщения Агента, отправленные в ответ на его действия или на сервисные сообщения, если они включены
Да
C помощью слота Change Chat ModeВажно: перед Change Chat Mode обязательно должен находиться Wait For ReactionПеревод на оператора также произойдет если webim не получит ответа от Агент в течение 5секунд
Нет
Слот Attachment передаст текстовую ссылку
Да
В client_message будет передана ссылка вида: https://www.google.com/maps/search/?api=1&query=62.174535,-75.937498
При использовании Слота Change Chat Mode происходит переключение на оператора.Чтобы перевести на оператора с помощью Change Chat Mode, этот Слот должен стоять обязательно после Слота Wait For Reaction. После переключения на оператора диалог завершается и отображается на странице Аналитики (Вкладка Аналитики).
При возникновении какой-либо ошибки запроса к API (ответ отличается от ожидаемого или запрос закрылся по таймауту 5 сек) чат автоматически переводится в общую очередь операторов.
Откроется панель выбора Конечный канал.
Откроется панель создания Канал Проекта.
По необходимости пропишите заголовок для данного Канал Проекта в поле названия с плейсхолдером New channel.
Cсылку на вебхук Канал Проекта (поле Chatbot webhook URL) скопируйте и вставьте в поле Ссылка на внешний API в настройках бота в Webim.
Для сохранения Канал Проекта без его активации, нажмите кнопку CREATE.
Для сохранения и активации Канал Проекта, нажмите кнопку CREATE & ACTIVATE.
Для отмены создания Канал Проекта нажмите кнопку CANCEL.
Для редактирования Канал Проекта, необходимо кликнуть по его иконке на карточке Агента.
Чтобы применить изменения к активированному Канал Проекта, нажмите кнопку APPLY.
Чтобы деактивировать Канал Проекта, нажмите кнопку DEACTIVATE.
Чтобы применить изменения к деактивированному Канал Проекта, нажмите кнопку SAVE.
Чтобы применить изменения и активировать Канал Проекта, нажмите кнопку SAVE & ACTIVATE.
Чтобы отменить внесение изменений, нажмите кнопку CANCEL.
Чтобы удалить Канал Проекта, нажмите кнопку DELETE.