Пользовательский код онлайн-чата
«Пользовательский код» позволяет подключить к клиентскому сайту готовый виджет онлайн-чата через HTML или JavaScript. Администратор вставляет код подключения, полученный в сервисе чата, либо код собственного виджета, подготовленный разработчиком.
Этот режим подходит, когда для подключения нужен полный фрагмент кода: несколько скриптов, дополнительные параметры, HTML-разметка или стили. Идентификаторы и настройки сервиса указываются внутри вставки, если этого требует сам сервис.
Для разных языков сайта можно сохранить отдельные варианты подключения. Внешний вид чата, расположение окна, приветствие и возможности общения определяются подключённым решением.
Где находится настройка
В панели управления откройте: «Настройки» — «Общие настройки»
В меню настроек, в группе «Дополнительно», выберите «Онлайн чат». На странице «Настройки онлайн-чата» откройте вкладку «Онлайн чат».
В поле «Тип онлайн чата» выберите «Пользовательский код».
Доступ к настройке
Для открытия страницы требуется доступ к настройкам онлайн-чата. Его предоставляет право «Разрешить управление онлайн чатом для заявок в админпанели» в группе прав «Заявки» либо право «Общие настройки» в группе прав «Админпанель».
Для работы с самой вставкой требуется дополнительное право «Пользовательский код онлайн-чата». Оно находится в группе прав «Заявки».
Это право позволяет просматривать и изменять код, выбирать формат, загружать текст из файла, возвращать предыдущую версию и включать пользовательский виджет.
Общий доступ к настройкам не предоставляет эти возможности автоматически. Сотрудник без отдельного права не получает редактор кода и историю вставок. Если пользовательский режим уже выбран, вместо редактора отображается сообщение о необходимом праве.
Сотрудник с доступом к настройкам онлайн-чата может отключить уже включённый виджет, даже если у него нет права редактировать код.
Где проверить право
В панели управления откройте: «Пользователи» — «Список групп пользователей»
Откройте группу сотрудника. В группе прав «Заявки» найдите «Пользовательский код онлайн-чата».
Изменение прав выполняет администратор, которому разрешено управлять соответствующей группой и выдавать это разрешение. После сохранения проверьте страницу онлайн-чата под учётной записью сотрудника: должны быть доступны редактор «Код виджета», выбор формата и «Загрузить из файла».
Сохранённая вставка выполняется в браузере посетителя и может обращаться к содержимому страницы. Используйте код доверенного сервиса или проверенный код разработчика. Не помещайте во вставку пароли, секретные API-ключи и другие закрытые данные: опубликованный код доступен посетителям сайта.
Настройка виджета
Тип онлайн чата
Выберите «Пользовательский код», чтобы использовать редактор вставки.
В этом режиме отдельное поле «App ID» не требуется. Если сервис использует идентификатор сайта, проекта или виджета, он должен присутствовать в коде подключения согласно инструкции этого сервиса.
При выборе другого типа онлайн-чата пользовательская вставка перестаёт подключаться. Её сохранённый текст остаётся в настройках.
Формат вставки
Формат определяет, как сайт обработает текст выбранной языковой вкладки.
Выберите «HTML», если вставка содержит теги <script>, HTML-разметку, стили или несколько отдельных элементов.
Код с открывающим и закрывающим тегами <script> относится к формату HTML, даже если внутри находится только JavaScript.
Пример формы записи:
Этот пример выводит сообщение в консоль браузера. Для подключения рабочего виджета используйте полный код вашего сервиса.
Выберите «JavaScript», если вставка содержит только JavaScript без тегов <script>.
Пример формы записи:
Этот пример выводит сообщение в консоль браузера. Рабочий код подключения вставляйте в том виде, который предоставляет сервис.
Для каждого языка сохраняется собственный формат. Например, одна языковая вкладка может содержать HTML, а другая — чистый JavaScript.
Переключение формата не преобразует содержимое поля: оно не добавляет и не удаляет теги <script>. Формат должен соответствовать вставленному тексту.
Код виджета
Вставьте полный код подключения. Сохраните адреса скриптов, идентификаторы, параметры и атрибуты, которые предоставляет сервис.
Редактирование поля не запускает виджет в административной панели. Код начинает использоваться на клиентском сайте после сохранения и загрузки страницы посетителем.
Максимальный размер вставки — 256 КБ, или 262 144 байта, для каждого языка. Размер показан под редактором.
Ограничение относится к тексту вставки. Если она загружает внешнюю библиотеку по ссылке, размер этой библиотеки не входит в размер поля «Код виджета».
Текст должен быть в кодировке UTF-8 и не содержать нулевых байтов. UTF-8 позволяет корректно сохранять русские буквы и другие символы.
Языковые вкладки
В редакторе отображаются языки клиентского сайта. Язык административной панели не определяет, какой код получит посетитель.
Для каждого языка можно сохранить отдельные код и формат. Это позволяет подключать разные виджеты, проекты или параметры сервиса для разных языковых версий.
При открытии сайта применяется следующий порядок:
Проверяется вставка языка, выбранного посетителем.
Если она отсутствует или содержит только пробелы и переводы строк, используется вставка основного языка сайта.
Если подходящего непустого кода нет и в основном языке, виджет не подключается.
Запасной вариант выбирается только из основного языка сайта. Другой заполненный язык не становится запасным автоматически.
Чтобы один виджет использовался на всех языковых версиях, заполните основной язык, а остальные вкладки оставьте пустыми.
Выбор вставки не переводит интерфейс стороннего чата автоматически. Если виджету нужен параметр языка, настройте его средствами сервиса или в предоставленном коде.
При изменении основного языка сайта меняется и запасной вариант для пустых вкладок. Проверьте, что вставка нового основного языка заполнена.
Если язык отключён в настройках сайта, его вкладка скрывается. Сохранённый код остаётся и становится доступен после повторного включения языка.
Загрузить из файла
Кнопка позволяет перенести текст из файла в выбранную языковую вкладку.
Доступны файлы .html, .htm, .js и .txt.
Выберите язык, для которого загружаете код.
Нажмите «Загрузить из файла».
Выберите текстовый файл в UTF-8 размером не более 256 КБ.
Дождитесь окончания чтения.
Проверьте содержимое «Код виджета» и выбранный формат.
Для .html и .htm устанавливается формат HTML, для .js — JavaScript. У файла .txt формат определяется по началу содержимого.
Проверьте соответствие расширения содержимому. Например, файл .js с тегами <script> потребует выбора HTML после загрузки.
Файл читается в браузере. В настройках сохраняется его текст после нажатия «Сохранить»; отдельный файл виджета на сервере не создаётся.
Во время чтения файла сохранение и редактирование вставки временно недоступны. Если чтение завершится ошибкой, ранее введённый код не заменяется.
Вставка кода из сообщения
При вставке в пустое поле или замене всего его содержимого редактор может подготовить текст, скопированный из сообщения:
убрать внешние ограждения Markdown-блока;
восстановить распознанные экранированные теги
<script>;убрать распознанное оформление ссылок, мешающее подключению скрипта.
Если текст был обработан, появляется сообщение «Удалено форматирование сообщения» и кнопка «Отменить обработку».
Проверьте результат перед сохранением. «Отменить обработку» возвращает исходный текст вставки в текущую языковую вкладку.
При вставке отдельного фрагмента внутрь существующего кода такая обработка не применяется.
Подготовка текста не исправляет произвольные ошибки JavaScript и не проверяет работоспособность сервиса.
Подключение на сайте
Порядок подключения
Откройте вкладку «Онлайн чат».
Включите «Включить онлайн чат».
В поле «Тип онлайн чата» выберите «Пользовательский код».
Выберите языковую вкладку.
Установите подходящий «Формат вставки».
Заполните «Код виджета» или используйте «Загрузить из файла».
При необходимости заполните остальные языковые вкладки.
Нажмите «Сохранить».
После успешного сохранения перезагрузите клиентский сайт.
Для включения требуется хотя бы одна непустая вставка среди доступных языков. Если нужен общий запасной вариант для всех языков, заполните основной язык сайта.
При сохранении проверяются права, допустимый формат, размер и корректность текстовых данных. Успешное сохранение подтверждает запись настроек. Появление и работа стороннего виджета проверяются отдельно на клиентском сайте.
Если в системе включено дополнительное подтверждение изменений настроек, завершите предусмотренную панелью процедуру подтверждения.
Где применяется вставка
Пользовательский код подключается на уровне клиентского сайта. Его загрузка предусмотрена при открытии главной страницы и других клиентских страниц, включая личный кабинет и страницу заявки.
Подключение доступно посетителям без входа в аккаунт. В административной панели этот код не выполняется.
Сам виджет может дополнительно ограничивать своё отображение по страницам или другим условиям. Такие правила определяются его кодом и настройками сервиса.
Кнопка чата не обязана находиться в определённом углу экрана. Расположение и способ открытия задаёт подключённое решение.
Когда выполняется код
Вставка запускается в браузере после первого отображения клиентского сайта. Она не выполняется при подготовке страницы на сервере.
Для открытого документа предусмотрена одна попытка выполнения вставки. Обычные переходы между страницами внутри сайта не запускают её повторно.
Если часть кода уже выполнилась, а затем возникла ошибка, автоматический повтор всей вставки не выполняется. После исправления кода нужна полная перезагрузка страницы.
Получение настроек ограничено по времени. При временной сетевой ошибке предусмотрена одна повторная попытка их загрузки.
Как размещаются HTML и скрипты
В формате JavaScript текст подключается как скрипт в <body> страницы.
В формате HTML:
обычная разметка и скрипты верхнего уровня добавляются в
<body>;отдельные элементы
<style>,<link>,<meta>и<title>размещаются в<head>;вложенные скрипты сохраняют своё положение внутри добавленной разметки.
Отдельного выбора места размещения в настройках нет. Если виджету требуется специальный способ подключения, он должен быть предусмотрен его вставкой.
Обычные скрипты выполняются с сохранением порядка зависимостей. Скрипты с async загружаются независимо; отложенные скрипты и модули подключаются после добавления разметки.
Сохраняйте атрибуты, предоставленные сервисом. Ошибка загрузки обычной внешней зависимости может остановить выполнение следующего зависимого кода.
Связь с чатом заявки
«Пользовательский код» подключает выбранное вами решение для общения с посетителями.
Настройки вкладки «Чат в заявках» относятся к отдельному чату заявки. Они не управляют сообщениями, файлами и уведомлениями произвольного стороннего виджета.
Сам выбор пользовательского режима не добавляет автоматическую передачу в сторонний чат номера заявки, реквизитов, статуса или выбранного направления обмена. Если такие возможности нужны, они должны быть предусмотрены подключённым решением и его интеграцией.
Проверка виджета
Откройте клиентский сайт:
Проверяйте результат после полной перезагрузки страницы.
Выберите язык, для которого сохранён отдельный код.
Найдите предусмотренную виджетом кнопку, окно или другую область общения.
Откройте чат.
Отправьте тестовое сообщение.
Проверьте получение сообщения в рабочем интерфейсе подключённого решения.
Ответьте на сообщение и проверьте получение ответа клиентом.
Для многоязычного сайта отдельно проверьте язык с собственной вставкой и язык с пустой вкладкой. Во втором случае должен использоваться код основного языка сайта.
Если меняли формат, загружали файл или возвращали предыдущую версию, проверьте соответствующий языковой вариант после сохранения.
Настройка рабочего чата подтверждена, когда выбранная вставка сохраняется, виджет появляется на нужной языковой версии и тестовое общение проходит в обе стороны.
Если результат не соответствует настройке
Код сохранился, но виджет не появился
Проверьте сохранённые значения «Включить онлайн чат» и «Тип онлайн чата». Для пользовательской вставки должен быть выбран «Пользовательский код».
Затем проверьте язык открытой клиентской страницы. Если его вкладка пустая, должен быть заполнен основной язык сайта.
Сверьте формат: вставка с тегами <script> требует HTML, а чистый JavaScript — формата JavaScript.
Выполните полную перезагрузку страницы. Если условия подключения соблюдены, проверьте адреса скриптов и идентификаторы по коду, полученному в сервисе. Недоступный внешний ресурс или ошибка самого виджета могут помешать его появлению после успешного сохранения настроек.
Не удаётся включить чат с пустыми вкладками
Сообщение «Вставьте код виджета перед включением пользовательского чата» означает, что среди доступных языков нет непустой вставки.
Заполните нужный язык. Для общего подключения заполните основной язык сайта и повторите сохранение.
Для сохранения пустой заготовки выключите «Включить онлайн чат».
Код или файл превышает допустимый размер
Сообщение «Код чата не должен превышать 256 КБ» относится к размеру вставки либо загружаемого файла.
Используйте предоставленный сервисом код подключения в пределах ограничения. Не удаляйте необходимые части вставки только ради уменьшения размера.
Файл не читается
При сообщении «Не удалось прочитать файл. Используйте текстовый файл в UTF-8» проверьте, что выбран текстовый файл нужного формата и он сохранён в UTF-8.
Файлы документов и изображения не подходят для загрузки в редактор кода.
Редактор недоступен сотруднику
Проверьте право «Пользовательский код онлайн-чата» в группе прав «Заявки».
Доступ к странице настроек сам по себе не разрешает просмотр, изменение и включение вставки.
Настройки временно не сохраняются
Сообщение «Настройки онлайн-чата сейчас сохраняются. Повторите сохранение через несколько секунд» появляется, когда другое сохранение этого раздела ещё выполняется.
Дождитесь завершения и повторите сохранение. После успешного результата проверьте содержимое нужных языковых вкладок и перезагрузите клиентский сайт.
Последнее обновление
Это было полезно?