Структура конфигурационного файла settings.json
Файлы чата
filename
Ядро виджета Чата (Javascript-файл)
По умолчанию:
"../../threadswidget-6.9.1.min.js"
Подключение к сервисам Чат-платформы
webchat/package, webchat/uid
Настройки интеграции с edna API
По умолчанию:
отсутствует
webchat/appMarker
Идентификатор приложения, используется для работы с несколькими приложениями в рамках одного канала.
По умолчанию:
отсутствует
webchat/checkURL
Адрес сервиса проверки доступности сети и push-платформы.
По умолчанию:
/favicon.ico
webchat/datastore
Адрес файлового хранилища
По умолчанию:
отсутствует
webchat/backend/rootUrl
Настройка адреса для API запросов
По умолчанию:
отсутствует
webchat/backend/history
Настройки интерфейса подгрузки истории сообщений.
По умолчанию:
{
"count": 20
}
webchat/backend/unauthorizedHistory
Настройка подгрузки истории сообщений для неавторизованной зоны.
count - количество подгружаемых сообщений за одно обращение к серверу
enable: true/false включение/отключение режима хранения истории.
cookie: объект настройки хранения идентификатора клиента, для получения истории сообщений. Ключ по умолчанию
Max-Age - время хранения.
Так же доступны другие параметры хранения, согласно официальной документации
По умолчанию:
{
"count": 20,
"enable": false,
"cookie": {
"Max-Age": 3600
}
}
webchat/opengraph
Настройка протокола OpenGraph, для получения превью при вставке ссылок в тексте сообщения
По умолчанию:
<URL_TO_DATASTORE>/opengraph?href=
webchat/xhrWithCredentials
Разрешить XMLHttpRequest.withCredentials
По умолчанию:
false
Настройки WS
webchat/websocket
Адрес websocket сервера
По умолчанию:
отсутствует
webchat/wsReconnectType
Способ переподключения WebSocket при потере подключения.
0 - (по умолчанию) переподключаться автоматически.
1 - переподключаться при отправке сообщения пользователем
По умолчанию:
0
webchat/wsMaxRetries
Количество попыток переподключения WebSocket
По умолчанию:
30
webchat/wsRetryTimeoutMs
Начальное время между попытками переподключения WebSocket (мс). Каждая новая попытка увеличивает предыдущее время вдвое
По умолчанию:
отсутствует
Настройки доступности Чата
webchat/isUnavailableOnStart
После загрузки страницы Чат будет скрыт, кроме случаев, когда у клиента был активный тред
По умолчанию:
false
webchat/schedule
Настройки доступности Чата
По умолчанию:
{
"interval": 1000
}
webchat/schedule/interval
Частота (в миллисекундах) с которой в интерфейсе происходит отображение изменений настройки "Режим работы чата" (настройка выполняется в АРМ Администратора). Отображение изменений будет происходить не чаще одного раза в указанный период, даже если в течение этого периода изменение настройки "Режим работы чата" произойдет много раз - все промежуточные события будут проигнорированы.
По умолчанию:
1000
webchat/activePages
Массив адресов страниц, на которых разрешен виджет Чата
По умолчанию:
[]
webchat/isContainerHidden
Управление видимостью стартовой кнопки чата. Подробности по управлению видимостью главного окна чата см. раздел “Управление видимостью виджета”
По умолчанию:
false
Настройки поведения Чата
webchat/disableClientValidation
Настройка, позволяющая отключить строгий режим валидации клиентских идентификаторов
По умолчанию:
false
webchat/maximizeOnInit
Настройка, позволяющая автоматически разворачивать окно Чата при первой инициализации приложения. Следующие запуски Чата будут игнорировать эту настройку (будет использоваться последнее известное состояние). Данная опция работает только при использовании стандартной стартовой кнопки, для этого параметр isContainerHidden (см. ниже) должен иметь значение false
По умолчанию:
false
webchat/disableQuoting
Настройка запрещающая цитирование сообщений (true/false)
По умолчанию:
false
webchat/disableFormatSimpleMessages
Отключение форматирование для сообщений (все, кроме сообщений бота содержащих markdown) (true/false)
По умолчанию:
false
webchat/enableInlineMediaPlayers
Включение встроенного плеера для воспроизведения медиа-вложений в области переписки (true/false)
По умолчанию:
true
webchat/typingInterval
Отправлять оператору уведомление о наборе пользователем сообщения не чаще указанного значения (мс)
По умолчанию:
3000
webchat/enableVoiceMessages
Разрешать клиенту записывать голосовые сообщения (убедитесь, что кнопка отправки включена)
По умолчанию:
false
webchat/maxInputLength
Настройка, позволяющая определить максимальную длину текста в поле ввода
По умолчанию:
4000
Локализация
webchat/locale
Локаль виджета. Доступные варианты: ru, en, id, az. Если значение не задано явно, то оно будет определено на основе языка браузера
По умолчанию:
отсутствует
webchat/locales
Переопределение локализационных текстов
По умолчанию:
"locales": {}
Настройки шапки Чата
webchat/hideBadBrowserWarning
Настройка скрытия предупреждения о неподдерживаемом браузере
По умолчанию:
false
webchat/chatHeader
Настройка шапки Чата
По умолчанию:
{
"showOrganisationUnit": false,
"hideSearchText": false
}
webchat/chatHeader/hideSearchText
Настройка, отключающая отображение текста в шапке Чата, выводимого при поиске оператора
По умолчанию:
false
webchat/chatHeader/showOrganisationUnit
Настройка, включающая отображение подразделения подключившегося оператора в шапке Чата
По умолчанию:
false
Настройки форм приветствия и обратной связи
webchat/hideWelcome
Настройка, позволяющая отключить показ блока приветствия
По умолчанию:
false
webchat/welcomeForm
Настройки контактной формы в блоке приветствия. Видимость блока приветствия (предложения представиться) настраивается с помощью параметров pre.text и pre.notice.
Для формы доступно использование любого набора полей из имеющихся: телефон, email, имя клиента. При отсутствии настройки форма содержит полный набор этих параметров. Для каждого поля задается отображение (visible) и обязательность заполнения (required).
Для телефона можно задать маску:
- для определения позиции цифр используется латинский символ X;
- для позиций цифр, которые необязательны к заполнению используется латинский символ Y (необязательные позиции допускаются только в конце маски).
Например:
строка "+7 (XXX) XXX-XX-XX" задает маску "+7 (___) ___-__-__";
строка "8 (XX) XXX-XX-YY" задает маску "8 (__) ___-__-__" где 2 последние позиции необязательны к заполнению.
Если маска не задана, по умолчанию допускается ввод только цифр, без разделителей, длина поля ограничена 15 цифрами.
Ошибки заполнения полей подсвечиваются
По умолчанию:
{
"pre": {
"text": true,
"notice": true
},
"phone": {
"visible": true,
"required": false,
"mask": "+7 (XXX) XXX-XX-XX"
},
"email": {
"visible": true,
"required": true
},
"name": {
"visible": true,
"required": false
}
}
webchat/inactivityForm
Настройки формы, отображаемой в режиме недоступности Чата (рис. 2). Имеется возможность создать свой набор полей из имеющихся (телефон, электропочта, имя клиента). Также, в этой секции можно изменить текст выводимый над формой и после отправки формы.
По умолчанию:
{
"phone": true,
"email": true,
"name": true
}
Данные клиента
webchat/clientId
Имя свойства объекта window в котором ожидается идентификатор авторизованного пользователя
По умолчанию:
"clientId"
webchat/clientData
Имя свойства объекта window в котором ожидается дополнительная информация о клиенте
По умолчанию:
"clientData"
webchat/extendedAuth
Параметры расширенной авторизации. Подробное описание в разделе Интеграции виджета
По умолчанию:
{}
webchat/signature
Имя свойства объекта window в котором ожидается цифровая подпись идентификатора авторизованного пользователя
По умолчанию:
"signature"
Настройки Web-нотификаций и Push-нотификаций
webchat/webNotification
Настройки нотификаций (рис. 3)
По умолчанию:
{
"title": "",
"icon": ""
}
webchat/webNotification/title
Заголовок нотификаций
По умолчанию:
отсутствует
webchat/webNotification/icon
Иконка нотификации в формате base64 (JPG/PNG).
По умолчанию:
отсутствует
webchat/disableWebNotification
Настройка для отправки нотификаций (true/false)
По умолчанию:
false
webchat/pushNotification
Настройка push уведомлений. Для включения уведомлений необходимо выставить enable: true, и заполнить раздел firebaseConfig данными своего проекта в Firebase. Пример настройки продемонстрирован в Руководство по началу работы
По умолчанию:
{
"enable": "false",
"firebaseConfig": {}
}
Настройки блока социальных ссылок
webchat/socialLinks
Настройка блока социальных ссылок
По умолчанию:
{
"visible": false,
"buttons": [
{
"url": "https://vk.com/",
"tooltip": "VK",
"image": "http://..."
}
]
}
webchat/socialLinks/visible
Включение / отключение блока социальных ссылок (true/false)
По умолчанию:
false
webchat/socialLinks/buttons
Кнопки панели социальных ссылок. Коллекция объектов, каждый из которых содержит три свойства: url (ссылка), tooltip (подсказка при наведении) и image (ссылка на изображение или data: URL изображения)
По умолчанию:
[
{
"url": "https://vk.com/",
"tooltip": "VK",
"image": "http://..."
}
]
Настройки WebWidget
webchat/WebWidget
Настройки области диалога выделенное под WebWidget
url - ссылка для перехода (обязательна).
image - ссылка на изображение или data: URL изображения (обязательна)
По умолчанию:
отсутствует
Рис. 1. Сообщение после отправки формы ввода контактных данных
Рис. 2. Форма, отображаемая в режиме недоступности Чата
Рис. 3. Браузерная нотификация