enВойти в Senler

Справочник init

Начните с подключения и приоритета настроек. Здесь собраны параметры первоначальной настройки. После запуска доступны отдельные runtime-параметры.

Справочник параметров init

Скрипт-загрузчик принимает только перечисленные параметры верхнего уровня:

КлючТипОбязательность / значение по умолчаниюНазначение
channel_idstringОбязательныйID канала типа «Виджет» из готового кода.
userobjectНеобязательныйДанные посетителя. Если передан external_id, рядом обязательна серверная подпись user_hash.
themeobjectНеобязательныйПереопределения оформления, popup-размеров, текстов и плавающей кнопки. Неуказанные поля берутся из настроек канала.
featuresobjectНеобязательныйПереопределения функций чата. Неуказанные поля берутся из настроек канала.
welcomeobjectНеобязательныйВид приветствия: mode: "centered_text" или mode: "automation_message" с automation_id и node_id разрешённого сообщения канала. Без параметра используются настройки канала.
lang"ru" | "en" | "auto""auto"Язык интерфейса.
display_mode"popup" | "embedded""popup"Способ размещения чата.
surfaceVisiblebooleantrueВидимость контейнера на сайте для учёта прочтения. Для скрываемой панели меняйте через updateRuntime; параметр не меняет её оформление.
button_onlybooleanfalseТолько неинтерактивная плавающая кнопка без iframe. Не совместим с embedded.
containerCSS-селектор или DOM ElementОбязательный для embeddedКонтейнер embedded-виджета. Передайте его и при старте в popup, если позже переключите режим через Public API.
shellobjectПустой объектcollapse_button и mobile_edge_swipe; оба выключены, пока не передано true.
onCollapsefunctionНеобязательныйФункция, вызываемая при запросе на сворачивание embedded-виджета.
onReadyfunctionНеобязательныйВызывается один раз после успешной инициализации чата; получает channel_id, display_mode, button_only. В button_only сообщает о готовности кнопки.
onErrorfunctionНеобязательныйПолучает первую ошибку запуска: Error с code, message, retryable. Подробности.
contextProviderfunctionНеобязательныйСинхронный поставщик постоянного контекста страницы.
resolveRuntimefunctionНеобязательныйСинхронно выбирает приветствие и оформление по данным посетителя и условиям сайта. Не выполняет команды диалога.
pageElementActionsobjectНеобязательныйАдаптер execute / clear для управления элементами встроенного приложения. Контракт и пример.
customActionsobjectПустой наборКнопки и действия сайта, доступные в чате.
customActionsLanguage"ru" | "en"Не заданЯзык описаний customActions.
debugbooleanfalseДополнительные сообщения скрипта-загрузчика в консоли.

Другие top-level ключи считаются ошибкой. Повторный SenlerWidget.init(...) удаляет текущий экземпляр и создаёт новый, поэтому для временных изменений используйте методы Public API.

Функции чата

Ключ featuresЧто включаетЗначение по умолчанию
file_uploadПрикрепление файлов.true
voice_messagesЗапись голосовых сообщений.false
emojiВыбор эмодзи.true
split_viewНа ширине от 640 пикселей показывает список диалогов и текущий чат рядом.true
element_selectionВыбор элемента основной страницы для вопроса.false

Для element_selection одной настройки недостаточно: чтобы агент получал устойчивые названия и мог находить элементы снова, добавьте разметку data-ai-*.