Содержание:
- Как разместить стандартный виджет на странице сайта
- Как передавать различную информацию в диалоги с помощью переменных
- Как включить отображение кнопок мессенджеров и социальных сетей
- Как запросить промежуточную оценку диалога
- Описание настроек виджета
Вы можете разместить виджет с ботом на странице вашего сайта. Это позволит увеличить продажи, оперативно осуществлять информирование пользователей на различные темы, а также своевременно оказывать помощь и техническую поддержку вашим клиентам.
Как разместить стандартный виджет на странице сайта
Для этого выполните следующие действия:
1) Создайте чат. Подробная информация о том, как создать новый чат, содержится в разделе Создание новых чатов.
2) В личном кабинете администратора перейдите в раздел Чаты - Настройки и нажмите кнопку Код фрейма напротив имени созданного чата.
3) В открывшемся окне скопируйте указанный ниже блок кода вручную или с помощью кнопки .
4) Разместите скопированный блок кода в коде страницы вашего сайта. Скопированный блок кода нужно разместить перед закрывающим тегом </body>.
Ниже приводится пример кода страницы с указанием места вставки блока кода виджета:
Если вы хотите разместить виджет на нескольких страницах вашего сайта, данную процедуру необходимо выполнить для каждой такой страницы.
Готово! После сохранения изменений в правом нижнем углу вашей страницы будет отображаться кнопка виджета.
client metadata s - Дочерний объект session defaults
Предназначена для ответа пользователю с учетом его часового пояса.
Если вы знаете временную зону клиента, то вы можете настроить бот таким образом, чтобы он отвечал пользователям в диалогах чата с учетом их часового пояса и времени суток. Данная функция особенно полезна в тех случаях, когда вы хотите проинформировать пользователя, например, о времени работы вашего магазина или сроке доставки его заказа.
Для этого в коде инициализаци скрипта с помощью переменной clientTimezone нужно настроить смещение в минутах относительно UTC.
Как передавать имя, адрес электронной почты и номер мобильного телефона пользователя в диалоги с помощью предустановленных переменных
С помощью переменных, предустановленных в коде инициализации виджета, вы можете передать в диалоги имена, адреса электронной почты
и номера мобильных телефонов пользователей
.
Для этого в коде инициализации виджетиа используется блок sessionDefaults, который содержит следующие переменные:
- clientName - имя пользователя;
- clientEmail - адрес электронной почты;
- clientPhone - номер мобильного телефона.
С помощью переменной с именем name можно задать имя, под которым диалог будет отображаться в личном кабинете оператора в случае, если диалог будет переведен на оператора.
Ниже представлен фрагмент кода, в котором объявлены указанные выше переменны с указанием места вставки в блоке кода инициализации виджета:.
При работе с предустановленными переменными в блоке sessionDefaults необходимо помнить следующее:
- Вы не можете изменять имена предустановленных переменных
- Вы не можете объявлять новые переменные
Вы можете только изменять значения сущесатвующих переменных. Например, вместо clientName: 'Иван Петров' вы можете написать clientName: 'Иванов Сергей ', но вы не можете изменить имя переменной, написав, например, clientName2: 'Иван Петров'. Кроме того, вы не можете объявить новую переменную, написав clientAddress: 'Москва, ул. Тверская 44, кв. 36'.
После того, как вы задали желаемые значения предустановленным переменным в коде инициализации виджета, необходимо в сценарии в одном или нескольких блоках "Вопрос" указать названия этих переменных, чтобы бот использовал их в вопросах. Имена переменных в блоках "Вопрос" нужно указывать с помощью фигурных скобок.
Для этого выполните следующее. Зайдите в личный кабинет администратора, перейдите в раздел Сценарии - Сценарии и нажмите кнопку напротив названия скрипта, который привязан к созданному чату.
Добавьте названия переменных в скрипт. Помните о том, что названия переменных необходимо указывать в фигурных скобках.
Ниже приводятся примеры добавления имени переменной в скрипт и отображения значения переменной в диалоге:
- Вместо имени переменной clientName в диалоге используется ее значение – имя клиента:
- Вместо имен переменных clientPhone и clientEmail в диалоге используются их значения – номер мобильного телефона и адрес электронной почты клиента:
Как передавать различную информацию в диалоги с помощью предустановленных переменных
Вы можете использовать в диалогах с пользователями любые переменные с различными значениями. Для этого в блоке инициализации необходимо объявить нужные переменные и задать желаемые значения, а в сценарии в одном или нескольких блоках "Вопрос" указать названия тех переменных, которые бот будет использовать в вопросах. Имена переменных в блоках "Вопрос" нужно указывать с помощью фигурных скобок. Пример ниже демонстрирует, каким образом можно при помощи переменных, заданных в коде инициализации виджета, передать в диалог имя клиента, адрес его электронной почты
и номер его мобильного телефона
.
Переменные создаются в блоке инициализации виджета с помощью объекта sessionDefaults. Давайте создадим следующие переменные:
- clientName - имя клиента;
- clientEmail - адрес электронной почты;
- clientPhone - номер мобильного телефон.
Ниже представлен фрагмент кода, в котором созданы указанные выше переменны.
TwinChat.init('#twin-chat-container', { chatId: '35a40e2c-4955-4ae3-a8e0-559fd4381244', sessionDefaults: { name: 'Диалог с клиентом', clientExternalId: 'externalKey', clientEmail: 'client@mail.ru', clientPhone: '79111234567', clientName: 'Иван', },
Чтобы добавить переменные в виджет, скопируйте представленный фрагмент кода в блок инициализации виджета, как показано на рисунке ниже.
Объект appearance позволяет задать язык, на котором будут отображаться названия кнопок виджета, включить режим отображения кнопок с пиктограммами мессенджеров и социальных сетей, а также отобразить пользователю запрос с просьбой оценить диалог.
Для этого добавьте к код инициализации виджета следующий фрагмент кодаЖ
Виджет имеет настройки, которые задаются при помощи объектов sessionDefaults, appearance и analytics. Ниже приводится фрагмент кода с этими объектами.
TwinChat.init('#twin-chat-container', { chatId: '35a40e2c-4955-4ae3-a8e0-559fd4381244', sessionDefaults: { name: 'Диалог с клиентом', clientExternalId: 'externalKey', clientEmail: 'client@mail.ru', clientPhone: '79111234567', clientName: 'Иван', orderNumber: '1234567', clientDeviceId: '0000-1111-2222-3333-44444444', clientTimezone: '-300' }, appearance: { lang: 'en', start: { mode: 'messengerButtons', }, rating: { midterm: 'Оцените, как проходит диалог', } analytics: { yandexMetrika: { counter: '86962928', // method: 'ym', // prefix: '/chat-widget', }, { googleAnalytics: { counter: '88777666', // method: 'gtag', // prefix: 'ChatWidget', }, }, } TwinChat.init('#twin-chat-container', { chatId: '35a40e2c-4955-4ae3-a8e0-559fd4381244', sessionDefaults: { name: 'Диалог с клиентом', clientExternalId: 'externalKey', clientMetadata: { age: 31, topic: "Открытие магазина", city: 'Москва' }, clientEmail: 'client@mail.ru', clientPhone: '79111234567', clientName: 'Иван', orderNumber: '1234567', clientDeviceId: '0000-1111-2222-3333-44444444', clientTimezone: '-300' }, appearance: { lang: 'en', start: { mode: 'messengerButtons', }, rating: { midterm: 'Оцените, как проходит диалог', } analytics: { yandexMetrika: { counter: '86962928', // method: 'ym', // prefix: '/chat-widget', }, { googleAnalytics: { counter: '88777666', // method: 'gtag', // prefix: 'ChatWidget', }, }, }
Объект appearance позволяет задать язык, на котором будут отображаться названия кнопок виджета, включить режим отображения кнопок с пиктограммами мессенджеров и социальных сетей, а также отобразить пользователю запрос с просьбой оценить диалог.
- lang - задает язык виджета (подробнее об изменении языка виджета см. Изменение языка виджета);
- start - задает режим отображения кнопок подключенных мессенджеров и социальных сетей. Чтобы при загрузке страницы рядом с кнопкой виджета отображались кнопки с пиктограммами всех подключенных в личном кабинете мессенджера и социальных сетей, то для опции mode нужно указать значение messengerButtons;
- rating - задает текст запроса промежуточной оценки диалога. В значении midterm введите текст, который должен отображаться в диалогах виджета при запросе у пользователя промежуточной оценки диалога;
Включение отображения кнопок мессенджеров и социальных сетей
Кнопки с пиктограммами мессенджеров и социальных сетей позволяют вашему клиенту на любом этапе диалога продолжить общение в чате мессенджера или социальной сети. Чтобы включить отображение данных кнопок для виджета, убедитесь, что в коде инициализации скрипта для параметра start указано значение messengerButtons (см. пример выше). Затем необходимо в личном кабинете администратора перейти в раздел Настройки, нажать кнопку Редактировать рядом с названием вашего чата и в открывшемся окне в разделе Ссылки на менеджеры указать ссылки на чаты, созданные в менеджерах и социальных сетях.
Перед подключением мессенджеров необходимо настроить интеграцию с ботом (подробнее см. Чаты).
Запрос промежуточной оценки диалога
Чтобы включить запрос у клиента промежуточной оценки во время диалога, необходимо в личном кабинете администратора перейти в раздел Настройки, нажать кнопку Редактировать рядом с названием вашего чата и в открывшемся окне выполнить следующие действия:
- В поле Через сколько секунд запросить отзыв о диалоге указать период времени, по завершению которого необходимо запрашивать у клиента отзыв;
- В поле Тип отзыва выбрать тип отзыва;
- В поле Текст оценки диалога вести текст сообщения, которое будет отображаться при запросе отзыва.
Виджет имеет настройки, которые задаются при помощи объектов sessionDefaults, appearance и analytics. Ниже приводится фрагмент кода с этими объектами.
TwinChat.init('#twin-chat-container', { chatId: '35a40e2c-4955-4ae3-a8e0-559fd4381244', sessionDefaults: { name: 'Диалог с клиентом', clientExternalId: 'externalKey', clientEmail: 'client@mail.ru', clientPhone: '79111234567', clientName: 'Иван', orderNumber: '1234567', clientDeviceId: '0000-1111-2222-3333-44444444', clientTimezone: '-300' }, appearance: { lang: 'en', start: { mode: 'messengerButtons', }, rating: { midterm: 'Оцените, как проходит диалог', } analytics: { yandexMetrika: { counter: '86962928', // method: 'ym', // prefix: '/chat-widget', }, { googleAnalytics: { counter: '88777666', // method: 'gtag', // prefix: 'ChatWidget', }, }, } TwinChat.init('#twin-chat-container', { chatId: '35a40e2c-4955-4ae3-a8e0-559fd4381244', sessionDefaults: { name: 'Диалог с клиентом', clientExternalId: 'externalKey', clientMetadata: { age: 31, topic: "Открытие магазина", city: 'Москва' }, clientEmail: 'client@mail.ru', clientPhone: '79111234567', clientName: 'Иван', orderNumber: '1234567', clientDeviceId: '0000-1111-2222-3333-44444444', clientTimezone: '-300' }, appearance: { lang: 'en', start: { mode: 'messengerButtons', }, rating: { midterm: 'Оцените, как проходит диалог', } analytics: { yandexMetrika: { counter: '86962928', // method: 'ym', // prefix: '/chat-widget', }, { googleAnalytics: { counter: '88777666', // method: 'gtag', // prefix: 'ChatWidget', }, }, }
Объект sessionDefaults передает в сценарий виджета системные и пользовательские переменные (например, ФИО клиента, день недели, контактный номер телефона, идентификатор клиента во внешней системе). Данные переменные можно использовать в диалогах виджета.
В указанном выше фрагменте кода используются следующие переменные:
- name (системная переменная) – имя диалога, которое отображается в кабинете оператора;
- clientExternalId (системная переменная) – идентификатор клиента, по которому будут группироваться чат-сессии в кабинете оператора;
- clientMetadata – содержит список переменных, которые задаются пользователем. Значения этих переменных передаются в сценарий. Вы можете задавать любые переменные. Например:
- age (пользовательская переменная) – возраст клиента;
- topic (пользовательская переменная) – тема диалога;
- city (пользовательская переменная) – город проживания клиента;
- clientEmail (пользовательская переменная) – адрес электронной почты клиента;
- clientPhone (пользовательская переменная) – контактный номер телефона клиента;
- clientName (пользовательская переменная) – имя клиента;
- orderNumber (пользовательская переменная) – номер заказа;
- clientDeviceId (пользовательская переменная) – идентификатор устройства клиента;
- clientTimezone (пользовательская переменная) – часовой пояс.
- age (пользовательская переменная) – возраст клиента;
- analytics – содержит свойства, которые позволяют подключить яндекс метрику для оценки частоты использования чата:
- yandexMetrika – имя используемой метрики;
- counter – идентификатор яндекс метрики;
- method – метод, который нужно вызывать при инициализации виджета. Можно использовать любой метод. По умолчанию применяется метод
'ym';
- prefix – пространство имен для идентификации событий виджета в отчетах Яндекс.Метрики. По умолчанию используется значение
'chat-widget'.
- googleAnalytics – имя используемой метрики;
- counter – идентификатор метрики Google Analytics;
- method – метод, который нужно вызывать при инициализации виджета. Можно использовать любой метод. По умолчанию применяется метод
'gtag';
- prefix – пространство имен для идентификации событий виджета в отчетах Google Analytics. По умолчанию используется значение
'chatWidget'.
- yandexMetrika – имя используемой метрики;
Чтобы применить указанные выше настройки виджета, необходимо добавить объекты sessionDefaults, appearance и analytics в код инициализации виджета.
Ниже указано место размещения фрагмента кода с объектами sessionDefaults, appearance и analytics в код инициализации виджета:
Вы можете использовать в диалогах с пользователями любые переменные с различными значениями. Для этого в блоке инициализации необходимо объявить нужные переменные и задать желаемые значения, а
Переменные создаются в блоке инициализации виджета с помощью объекта sessionDefaults. Давайте создадим следующие переменные:
- clientName - имя клиента;
- clientEmail - адрес электронной почты;
- clientPhone - номер мобильного телефон.
Ниже представлен фрагмент кода, в котором созданы указанные выше переменны.