ym88659208ym87991671
Подключаем чат-бот к Webim | Документация для разработчиков

Подключаем чат-бот к Webim

Обновлено 19 сентября 2024

Webim - омниканальная платформа для онлайн-консультирования клиентов. Вы можете автоматизировать коммуникации в чат-платформе подключив созданный сценарий вашего чат-бота на Code и Graph к чат-платформе Webim.

Настройка интеграции c платформой Webim

Для настройки интеграции:

  1. Предварительно запросите доступ к Webim.

  2. Оформите заявку Разработка ботов с интеграцией Webim. При получении заявки в работу вы получите письмо на указанный ранее адрес. После согласования заявки модератором новая интеграция появится в списке интеграций проекта SaluteBot.

  3. Откройте проект SaluteBot и перейдите в раздел Настройки.

  4. В форме выбора чат-платформы выберите в качестве интеграции Webim и нажмите Далее.

  5. Сгенерируйте токен ботовой интеграции для авторизации запросов в личном кабинете пользователя Webim и скопируйте его.

  6. Перейдите в Webim и в поле Вебхук введите любое значения для получения токена.

  7. Введите полученное значение вебхука для интеграции проекта SaluteBot.

  8. Укажите следующие параметры:

НазваниеОписание
Токен авторизацииТокен интеграции с чат-платформой, который используется для авторизации вызовов в чат-платформу.
Обязательно для заполнения
Адрес доменаАдрес домена аккаунта для интеграции с чат-платформой.
Указанное значение домена используется для формирования вызовов в чат-платформу, например, https://salutebot.webim.ru/.
Обязательно для заполнения
Переводить наВыбор способа перехода:
- Переводить на отдел (значение по умолчанию).
- Переводить на оператора.
Если выбран способ Переводить на отдел, следует указать ID отдела, если способ Переводить на оператора - ID оператора.
Обязательно для заполнения
ID отделаИдентификатор отдела для перевода диалога на выбранный отдел.
ID отдела можно найти в личном кабинете пользователя Webim, в разделе Отделы левого вертикального меню. Для этого выберите название отдела и скопируйте ID в поле Буквенный идентификатор отдела.
Поле отображается только в случае, если в поле Переводить на выбрано Переводить на отдел.
Обязательно для заполнения
ID оператораИдентификатор сотрудника для перевода диалога на конкретного оператора.
ID оператора можно найти в личном кабинете пользователя Webim, в разделе Сотрудники левого вертикального меню.
Поле отображается только в случае, если в поле Переводить на выбрано Переводить на оператора.
Обязательно для заполнения
  1. Нажмите Добавить. В результате будет выполнен запрос на добавление интеграции.

Ограничения

В работе интеграции временно недоступны следущие функциональности:

  • Возможность получения информации о канале, из которого пришел пользователь. Поэтому для Webim:

    • для Code: в переменной $request.userChannel всегда будет приходить значение канала = webim, исходный канал указан не будет;
    • для Graph: в переменной $userChannel также не будет указан исходный канал.
  • Использование языка разметки Markdown в исходящих сообщениях чат-бота. Сообщения, отправленные с разметкой Markdown, будут приходить пользователю Webim простым plain-текстом.

  • Создание кнопок со ссылками. Отправленные чат-ботом кнопки ссылки будут представлены URL-ссылками.

  • Переход Оператор завершил диалог в блоке Перевод на оператора. Таким образом обработка возврата диалога от оператора из блока невозможна.

  • Отправка контактных данных пользователем в чат-бот с помощью блока Отправить данные оператору. При выполнении в сценарии будет выполнен переход по ошибке.

ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.