Виджет Мессенджера для сайта или приложения

Виджет доступен в тарифах Основной, Продвинутый и Корпоративный из новой линейки, а также тарифе Оптимальный из старой.

С помощью виджета вы можете встроить полноценное окно Яндекс Мессенджера на страницы вашего корпоративного сайта или веб-приложения. Ваши сотрудники смогут безопасно общаться друг с другом.

Вы можете использовать виджет:

  • на корпоративном сайте;
  • в мобильном приложении через WebView.

Виджет Мессенджера для сайта или приложения

Варианты отображения виджета и примеры использования

Вариант отображения

Где можно использовать

Inline-блок

Встраивается в место на странице и занимает 100% высоты и ширины узла, в который он встроен.

На корпоративном портале

Можно добавить inline-блок со списком рабочих чатов, которые увидит пользователь после входа с использованием SSO или OAuth.

Плавающая кнопка со всплывающим окном

Обычно отображается в правом нижнем углу, окно Мессенджера появляется при нажатии на кнопку.

Для внутренней службы поддержки

Плавающая кнопка будет открывать чат службы поддержки для сотрудников. С помощью API виджета можно сразу открыть чат с конкретным сотрудником или ботом по ID.

Отдельное всплывающее окно

Подходит, если у вас есть своя кнопка открытия виджета и вы сами хотите настроить поведение.

При HR-онбординге

Виджет сразу открывает чат приветствия новичка с ботом и HR-менеджером. Также можно настроить открытие чата с определенным ботом.

Внимание

Используйте виджет Мессенджера только для внутрикорпоративного общения. Он не подходит для общения службы поддержки с внешними пользователями или как CRM-виджет.

Как подключить виджет

Для подключения виджета нужно участие администратора Яндекс 360 и фронтенд-разработчика.

Администратору

  1. Отправьте запрос в поддержку. Выберите в форме пункт «Другое» и укажите:

    • список доменов или хостов, где будет размещен виджет;
    • ожидаемую RPS-нагрузку;
    • ваши контактные данные.
  2. В ответном письме вы получите serviceId, который понадобится для подключения виджета на сайт. Получение serviceId может занять до трех недель.

  3. Передайте serviceId фронтенд-разработчику.

Фронтенд-разработчику

  1. Подключите пакет yandex-messenger-widget.

  2. Создайте OAuth-приложение в Яндекс ID:

    1. Выполните пункты 1.1–1.4 документации API.

    2. Укажите необходимые права доступа: Чтение и отправка сообщений в чатахyamb:all.

    3. Настройте передачу OAuth-токенов пользователей в виджет при каждом открытии.

      Важно

      OAuth-токены допустимо хранить на бэкенде сервиса. Не используйте для этого локальное хранилище браузера.

    4. Зарегистрируйте ваше OAuth-приложение на странице Создание приложения.

  3. Напишите код и встройте UI виджета в сайт.

  4. Мессенджер открывается в <iframe>, поэтому подготовьте CSP-заголовки для вашего сайта, которые разрешат использование этого элемента на сайте.

  5. Настройте тему отображения Мессенджера и флаги, которые определяют его поведение.

  6. Протестируйте виджет и убедитесь, что все работает правильно.

  7. После этого можно добавить виджет на действующий сайт и рассказать о нем пользователям.

  8. Подпишитесь на события и следите за доступностью функциональности.

Подробная документация для разработчиков включает подробный пример интеграции для React-приложения и доступна здесь:

Написать в службу поддержки