Виджет
Подключение виджета
С виджетом можно взаимодействовать через глобальный объект: window.usedeskMessenger
Инициализируется (подключается к серверу, получает нужные данные) он автоматически.
Методы виджета
| Заголовок | Описание |
|---|---|
| open() | Просто открывает виджет |
| open('chat') | Позволяет открывать виджет на определенном экране(либо ссылке), переданном в параметрах:
|
| close() | Закрывает виджет |
| openChat() | Открыть чат Deprecated (версия 1.0): Не рекомендуем использовать. Работа с действием открытия вынесена в параметр open |
| openDocs() | Открыть базу знаний Deprecated (версия 1.0): Не рекомендуем использовать. Работа с действием открытия вынесена в параметр open |
| openCallback() | Открыть форму обратной связи Deprecated (версия 1.0): Не рекомендуем использовать. Работа с действием открытия вынесена в параметр open |
| openWhatsapp() | Открыть вацап Deprecated (версия 1.0): Не рекомендуем использовать. Работа с действием открытия вынесена в параметр open |
| closeChat() | Закрыть чат (и пока тоже любую форму) Deprecated (версия 1.0): Не рекомендуем использовать. Работа с действием открытия вынесена в параметр close |
| closeDocs() | Закрыть базу знаний Deprecated (версия 1.0): Не рекомендуем использовать. Работа с действием открытия вынесена в параметр close |
| closeCallback() | Закрыть форму обратной связи Deprecated (версия 1.0): Не рекомендуем использовать. Работа с действием открытия вынесена в параметр close |
| closeWhatsapp() | Закрыть вацап Deprecated (версия 1.0): Не рекомендуем использовать. Работа с действием открытия вынесена в параметр close |
| toggle() | Скрывает виджет с браузера пользователя либо показывает его в зависимости от значения переключения Метод принимает параметры:
|
| userIdentify() | Идентифицирует пользователя по переданным параметрам. Метод принимает параметры:
Deprecated (версия 1.0)
|
| getChatToken() | Отображает токен инициированного чата |
Пример для получения token:
Виджет может автоматически проинициализироваться, если в коде страницы к моменту подключения виджета уже будет существовать такой callback:
Если же вы не используете первый способ (через window.__widgetInitCallback), то при использовании прямого вызова(ниже) будьте уверены в том, что пользователь не успеет кликнуть и открыть чат до того, как вам станут известны его данные и вы сможете прокинуть их в чат через прямой вызов identify.
Рекомендуем в таком случае скрывать и показывать виджет только после того, как станут известны данные пользователя и вы сможете их отправить в виджет.
Инициализация сообщения от клиента
Метод для отправки сообщений в виджет с его открытием-созданием чата: window.usedeskMessenger.sendMessage
Методы виджета
| Заголовок | Описание |
|---|---|
| message | Текст который будет отправлен в виджет от лица текущего клиента |
Если необходимо указать почту, система будет ожидать пока не откроется окно чата и сразу отправит сообщение
Изменение дополнительных полей
Метод для изменения уже существующих полей в запросе window.usedeskMessenger.setAdditionalFields
Используйте метод при передаче значений в уже существующий запрос. Значения, которые вы передаете, обновятся к текущем запросе
Кнопки в виджете
В виджет можно выводить кнопки, формируя в сообщении определенные параметры.
Параметры
* обязательные поля
| Параметр | Значение |
|---|---|
| button* | Служебный идентификатор кнопки |
{текст}* | Любой текст кнопки. При превышении ширины виджета текст обрезается |
| {ссылка} | URL перехода клика по кнопке. Если параметр пустой, то клик по кнопке отправляет сам текст кнопки в ответ(например, чтобы вызвать ответ бота) |
| {тип ссылки} | Может принимать одно из двух значений:
Говорит где открывать ссылку — в новом или текущем окне соответственно Если URL не заполнен, значение параметра игнорируется |
| {видимость} | Показывать или не показывать текст из кнопки в самом тексте(если он там есть) Может принимать одно из двух значений:
Если в тексте передать так же текст кнопки и у кнопки указать noshow, то текст будет только показываться на кнопке. Отправили: Возьми дробовик Винсент {{button:Возьми дробовик;;;noshow}} Получили: Винсент "Возьми дробовик" Если в тексте передать что-то и указать show, то кнопка не повлияет на исходный текст Отправили: Возьми дробовик Винсент {{button:Возьми дробовик;;;noshow}} Получили: Возьми дробовик винсент "Возьми дробовик"
|
В случае, если произошла ошибка в конфигурировании кнопки - кнопка и её настройки не будут отображены в виджете.
Цвет текста и фона кнопки конфигурируются на странице настроек виджета ("Цвет текста кнопки в сообщениях" и "Цвет фона кнопки в сообщениях"). При этом включены цвета по умолчанию, если параметры не заданы.
Пример: Возьми дробовик Винсент {{button:Возьми дробовик;https://usedesk.ru;blank;show}}
Идентификаторы элементов виджета
Для сбора статистики или кастомизации виджета можно обращаться к различным элементам виджета через их уникальные идентификаторы:
- Сама иконка виджета - uw-main-button
- Кнопка закрытия виджета - uw-main-button-close
- Кнопка закрытия окна чата при активном чате - uw-close-chat-button
- Кнопка "Задача завершена?" - uw-task-solved-button
- Кнопка отправки сообщения - uw-message-submit-button
- Кнопка вложения - uw-attachment-button
- Каждая из возможных кнопок каналов:
- id: 'uw-button-facebook',
- id: 'uw-button-telegram',
- id: 'uw-button-ok',
- id: 'uw-button-viber',
- id: 'uw-button-vk',
- id: 'uw-button-skype',
- id: 'uw-button-whatsapp',
- id: 'uw-button-instagram',
- Кнопка отправки имэйла при начале диалога в чате - uw-send-email-button
- Нажатие на кнопку "Назад" и на кнопку "Написать нам" при просмотре статьи в базе знаний:
- uw-button-docs-write
- uw-button-docs-back