Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

Message Box
iconnone
titleСодержание:
typegeneric

Вы можете разместить виджет с ботом на странице вашего сайта. Это позволит увеличить продажи, оперативно информировать пользователей на различные темы, а также своевременно оказывать помощь и техническую поддержку вашим клиентам.

Якорь
addwidget
addwidget

Как разместить стандартный виджет на странице сайта

Для этого выполните следующие действия:

1) Создайте чат. Подробная информация о том, как создать новый чат, содержится в разделе Создание новых чатов.

Подсказка

При создании чата требуется указать сценарий, который будет использоваться в диалогах чата. Подробная информация о создании сценариев содержится в разделе Редактор сценариев.

2) В личном кабинете администратора перейдите в раздел Чаты Настройки и нажмите кнопку Код фрейма напротив имени созданного чата.

3) В открывшемся окне скопируйте указанный ниже блок кода вручную или с помощью кнопки .

Подсказка

Информация об отличиях новой версии виджета от предыдущей.

4) Разместите скопированный блок кода в коде страницы вашего сайта. Его нужно разместить перед закрывающим тегом </body>.

Ниже приводится пример кода страницы с указанием места расположения блока кода виджета:

Подсказка

Если вы хотите разместить виджет на нескольких страницах вашего сайта, данную процедуру необходимо выполнить для каждой такой страницы. 

Готово! После сохранения изменений в правом нижнем углу вашей страницы будет отображаться кнопка виджета.

Якорь
variables1
variables1

Как передавать в диалоги имя, email и номер телефона пользователя с помощью предустановленных переменных

С помощью предустановленных переменных вы можете передать в диалоги имена, адреса электронной почты и номера телефонов пользователей.

Для передачи в диалоги имен, адресов электронной почты и номеров телефонов в коде инициализации виджета используется блок sessionDefaults, который содержит следующие переменные:

  • clientName имя пользователя;
  • clientEmail адрес электронной почты;
  • clientPhone номер телефона.
Подсказка

Блок sessionDefaults также содержит переменную с именем name, с помощью которойможно задать имя, под которым диалог будет отображаться в личном кабинете оператора в случае, если диалог будет переведен на оператора.    

Давайте в качестве примера использовать следующие значения:

  • Имя пользователя – Иван Петров;
  • Адрес электронной почты – client@mail.ru;
  • Номер телефона – 79111234567;
  • Название диалога при переводе в личный кабинет оператора черная пятница.

Ниже представлен фрагмент кода, в котором предустановленным переменным присвоены указанные выше значения. Ниже также указано место расположения этого фрагмента кода в коде инициализации виджета:

Блок кода
languagejs
linenumberstrue
 		  sessionDefaults: {
                name: 'Черная пятница',
                clientEmail: 'client@mail.ru',
                clientPhone: '79111234567',
                clientName: 'Иван Петров',
            },

Раскрыть
titleПолный фрагмент кода инициализации виджета


Блок кода
languagejs
linenumberstrue
<!DOCTYPE html>
<html>
<body>
<div id="twin-chat-container"></div> 
<script> 
  (function () { 
    const script = document.createElement('script'); 
    script.async = true; 
    script.src = 'https://modern-v3.twin24.ai/manual.umd.min.js'; 
    document.head.appendChild(script); 
    script.onload = () => { 
      TwinChat.init('#twin-chat-container', { 
        chatId: 'febb3685-2cbc-4815-ba13-96199f9b8beb',
		  sessionDefaults: {
                name: 'Черная пятница',
                clientEmail: 'client@mail.ru',
                clientPhone: '79111234567',
                clientName: 'Иван Петров',
            },
      }).then(client => window.TwinClient = client); 
    }; 
  })(); 
</script>

</body>
</html>



Предупреждение

При работе с предустановленными переменными в блоке sessionDefaults необходимо помнить следующее:

  • Вы можете изменять значения существующих переменных;
  • Вы не можете изменять имена предустановленных переменных;
  • Вы не можетеобъявлять новые переменные.

Например, вместо clientName: 'Иван Петров' вы можете написать clientName: 'Иванов Сергей' или clientName: 'Наталья', но вы не можете изменить имя переменной, написав, например, clientName2: 'Иванов Сергей' или natalya: 'Наталья'. Вы не можете объявить новую переменную, написав, например: clientAddress: 'Москва, ул. Тверская 44, кв. 36'.

После того как вы задали в коде инициализации виджета предустановленным переменным желаемые значения, вам нужно указать названия переменных в сценарии в одном или нескольких блоках "Вопрос", чтобы бот использовал значения этих переменных в вопросах.

Для этого выполните следующее. Зайдите в личный кабинет администратора, перейдите в раздел Сценарии  Сценарии и нажмите кнопку напротив названия скрипта, который привязан к созданному чату.

Добавьте названия переменных в соответствующие блоки "Вопрос" скрипта. Помните о том, что названия переменных необходимо указывать в фигурных скобках.

Ниже приводятся примеры добавления имен переменных в скрипт и отображение их значений в диалоге:

  • Вместо имени переменной clientName в диалоге используется ее значение – имя пользователя:

 

  • Вместо имен переменных clientPhone и clientEmail в диалоге используются их значения: номер телефона и адрес электронной почты пользователя:

Якорь
variables2
variables2

Как передавать различную информацию в диалоги с помощью пользовательских переменных

Дочерний объект session defaults

Вы можете использовать в диалогах с пользователями любые переменные с различными значениями. Для этого в коде инициализации виджета нужно разместить объект clientMetadata, который является дочерним объектом sessionDefaults. Объект clientMetadata может содержать любое количество переменных с любыми именами.

Примечание

При работе с объектом clientMetadata важно помнить следующее:

  • В коде инициализации виджета можно указать только один объект с именем clientMetadata. Не допускается создавать несколько объектов clientMetadata с одинаковыми или разными именами.
  • Имена создаваемых вами переменных должны быть уникальными как внутри объекта clientMetadata, так и внутри родительского объекта sessionDefaults

Давайте создадим с помощью объекта clientMetadata следующие переменные:

  • orderNumber – номер заказа;
  • address – адрес пункта выдачи товара;
  • finalDate – конечная дата резерва.

В качестве примера будем использовать следующие значения:

  • Номер заказа – 31;
  • Адрес пункта выдачи товара – Москва, Некрасова 13;
  • Конечная дата резерва – 13 июня 2022 года.

Ниже представлен фрагмент кода, в котором созданы указанные выше переменные. Ниже также показано место расположения данного фрагмента кода в коде инициализации виджета:

Блок кода
languagejs
linenumberstrue
                 clientMetadata: {
                    orderNumber: 31,
                    address: "Москва, Некрасова 13",
                    finalDate: '13 июня 2022 года'
                }, 



Раскрыть
titleПолный фрагмент кода инициализации виджета


Блок кода
languagejs
linenumberstrue
<!DOCTYPE html>
<html>
<body>
<div id="twin-chat-container"></div> 
<script> 
  (function () { 
    const script = document.createElement('script'); 
    script.async = true; 
    script.src = 'https://modern-v3.twin24.ai/manual.umd.min.js'; 
    document.head.appendChild(script); 
    script.onload = () => { 
      TwinChat.init('#twin-chat-container', { 
        chatId: 'febb3685-2cbc-4815-ba13-96199f9b8beb',
		  sessionDefaults: {
                clientMetadata: {
                    orderNumber: 31,
                    address: "Москва, Некрасова 13",
                    finalDate: '13 июня 2022 года'
                },
                clientEmail: 'client@mail.ru',
                clientPhone: '79111234567',
                clientName: 'Иван',
            },	
      }).then(client => window.TwinClient = client); 
    }; 
  })(); 
</script>

</body>
</html>


После того как вы создали переменные в коде инициализации виджета и задали им значения, необходимо указать названия переменных в сценарии в одном или нескольких блоках "Вопрос", чтобы бот использовал значения этих переменных в вопросах.

Для этого выполните следующее. Зайдите в личный кабинет администратора, перейдите в раздел СценарииСценарии и нажмите кнопку напротив названия скрипта, который привязан к созданному чату.

Примечание

Добавьте названия переменных в соответствующие блоки "Вопрос" сценария.

Помните о том, что названия переменных нужно указывать в фигурных скобках.

Ниже приводятся примеры. Вместо имен переменных orderNumber, address и finalDate в диалогах используются их значения: номер заказа, адрес пункта выдачи и конечная дата резерва.

 



Якорь
variables3
variables3


Якорь
review
review

Как запросить у пользователя промежуточную оценку диалога

Чтобы во время диалога с пользователем запросить промежуточную оценку диалога, необходимо в личном кабинете администратора перейти в раздел Настройки, нажать кнопку Редактировать рядом с названием вашего чата и в открывшемся окне выполнить следующие действия:

  • В поле Через сколько секунд запросить отзыв о диалоге указать период времени, по завершению которого необходимо запрашивать у пользователя промежуточную оценку диалога;
  • В поле Тип отзыва выбрать тип отзыва. Доступны следующие варианты:
    • 2-х балльная;
    • 5-ти балльная;
    • 10-ти балльная.
  • В поле Текст оценки диалога ввести текст сообщения, которое будет отображаться пользователю при запросе отзыва.

Ниже наглядно показано, каким образом можно запросить у пользователя промежуточную оценку диалога по 5-ти балльной шкале через 15 секунд после начала диалога. Запрос промежуточной оценки будет отображаться вместе со следующим текстом сообщения: "Пожалуйста, оцените помощь оператора".


Якорь
buttonsdisplay
buttonsdisplay

Как включить отображение кнопок мессенджеров и социальных сетей при запуске виджета

Кнопки с пиктограммами мессенджеров и социальных сетей позволяют пользователю на любом этапе диалога продолжить общение в чате соответствующего мессенджера или социальной сети. Чтобы включить отображение данных кнопок для виджета, убедитесь, что в коде инициализации скрипта расположен объект appearance, который содержит дочерний объект start. В объекте start должен бытьуказан параметр mode со значением messengerButtons.

Блок кода
languagejs
linenumberstrue
            appearance: {
                start: {
                    mode: 'messengerButtons',
                },
                },	

Раскрыть
titleПолный фрагмент кода инициализации виджета


Блок кода
languagejs
linenumberstrue
<!DOCTYPE html>
<html>
<body>
<div id="twin-chat-container"></div> 
<script> 
  (function () { 
    const script = document.createElement('script'); 
    script.async = true; 
    script.src = 'https://modern-v3.twin24.ai/manual.umd.min.js'; 
    document.head.appendChild(script); 
    script.onload = () => { 
      TwinChat.init('#twin-chat-container', { 
        chatId: 'febb3685-2cbc-4815-ba13-96199f9b8beb',
		  sessionDefaults: {
                name: 'Черная пятница',
                clientMetadata: {
                    orderNumber: 31,
                    address: "Москва, Некрасова 13",
                    finalDate: '13 июня 2022 года'
                },
                clientEmail: 'client@mail.ru',
                clientPhone: '79111234567',
                clientName: 'Иван',
            },
            appearance: {
                start: {
                    mode: 'messengerButtons',
                },
                },		
      }).then(client => window.TwinClient = client); 
    }; 
  })(); 
</script>

</body>
</html>


После этого в личном кабинете администратора необходимо перейти в раздел Настройки, нажать кнопку Редактировать рядом с названием вашего чата и в открывшемся окне в разделе Ссылки на менеджеры указать ссылки на чаты, созданные в менеджерах и социальных сетях.

Примечание

Перед указанием ссылок на мессенджеры и социальные сети необходимо настроить интеграцию с ботом (подробнее см. Чаты).


После выполнения указанных выше действий при запуске виджета будут автоматически отображаться кнопки мессенджеров и социальных сетей.

Якорь
language
language

Как изменить язык виджета

Язык виджета можно изменить с помощью объекта appearance. Свойство lang этого объектапозволяет изменить язык виджета на английский. Для этого в код инициализации виджета необходимо добавить следующий фрагмент кода.

Блок кода
languagejs
linenumberstrue
            appearance: {
                lang: 'en',
                start: {
                    mode: 'messengerButtons',
                },
                },	

Раскрыть
titleПолный фрагмент кода инициализации виджета


Блок кода
languagejs
linenumberstrue
<!DOCTYPE html>
<html>
<body>
<div id="twin-chat-container"></div> 
<script> 
  (function () { 
    const script = document.createElement('script'); 
    script.async = true; 
    script.src = 'https://modern-v3.twin24.ai/manual.umd.min.js'; 
    document.head.appendChild(script); 
    script.onload = () => { 
      TwinChat.init('#twin-chat-container', { 
        chatId: 'febb3685-2cbc-4815-ba13-96199f9b8beb',
		  sessionDefaults: {
                name: 'Черная пятница',
                clientMetadata: {
                    orderNumber: 31,
                    address: "Москва, Некрасова 13",
                    finalDate: '13 июня 2022 года'
                },
                clientEmail: 'client@mail.ru',
                clientPhone: '79111234567',
                clientName: 'Иван',
            },
            appearance: {
                lang: 'en',
                start: {
                    mode: 'messengerButtons',
                },
                },		
      }).then(client => window.TwinClient = client); 
    }; 
  })(); 
</script>

</body>
</html>


После того как вы выполните описанные выше действия, язык виджета будет изменен на английский. Переведите сценарий на английский язык и разместите виджет на англоязычной версии страницы вашего сайта.

Якорь
widgetsettings
widgetsettings

Как подключить к виджету метрики yandexMetrika и googleAnalytics

Вы можете настроить сбор статистики по действиям пользователей в виджете с помощью метрик yandexMetrika и googleAnalytics. Для этого в объекте analytics нужно разместить дочерние объекты yandexMetrika и googleAnalytics. Сам объект analytics должен быть расположен внутри объекта appearance. Ниже приводится описание объектов analytics, yandexMetrika и googleAnalytics.

  • analytics – содержит свойства, которые позволяют подключить метрику yandexMetrika для оценки частоты использования чата:
    • yandexMetrika – имя используемой метрики;
      • counter – идентификатор метрики yandexMetrika;
      • method – метод, который нужно вызывать при инициализации виджета. Можно использовать любой метод. По умолчанию применяется метод 'ym';
      • prefix – пространство имен для идентификации событий виджета в отчетах yandexMetrika. По умолчанию используется значение 'chat-widget'.
    • googleAnalytics – имя используемой метрики;
      • counter – идентификатор метрики googleAnalytics;
      • method – метод, который нужно вызывать при инициализации виджета. Можно использовать любой метод. По умолчанию применяется метод 'gtag';
      • prefix – пространство имен для идентификации событий виджета в отчетах googleAnalytics. По умолчанию используется значение 'chatWidget'.

Ниже представлен фрагмент кода с объектом analytics и его дочерними объектами yandexMetrika и googleAnalytics. Ниже также указано место расположения этого фрагмента кода в коде инициализации виджета:

Блок кода
languagejs
linenumberstrue
                 analytics: {
                    yandexMetrika: {
                        counter: '86962928',
                        // method: 'ym',
                        // prefix: '/chat-widget',
                    },
                    {
                        googleAnalytics: {
                            counter: '88777666',
                            // method: 'gtag',
                            // prefix: 'ChatWidget',
                        },
                    },
                }       


Раскрыть
titleПолный фрагмент кода инициализации виджета


Блок кода
languagejs
linenumberstrue
<!DOCTYPE html>
<html>
<body>
<div id="twin-chat-container"></div> 
<script> 
  (function () { 
    const script = document.createElement('script'); 
    script.async = true; 
    script.src = 'https://modern-v3.twin24.ai/manual.umd.min.js'; 
    document.head.appendChild(script); 
    script.onload = () => { 
      TwinChat.init('#twin-chat-container', { 
        chatId: 'febb3685-2cbc-4815-ba13-96199f9b8beb',
		  sessionDefaults: {
                name: 'Черная пятница',
                clientMetadata: {
                    orderNumber: 31,
                    address: "Москва, Некрасова 13",
                    finalDate: '13 июня 2022 года'
                },
                clientEmail: 'client@mail.ru',
                clientPhone: '79111234567',
                clientName: 'Иван',
            },
            appearance: {
                lang: 'en',
                start: {
                    mode: 'messengerButtons',
                },
                 analytics: {
                    yandexMetrika: {
                        counter: '86962928',
                        // method: 'ym',
                        // prefix: '/chat-widget',
                    },
                    {
                        googleAnalytics: {
                            counter: '88777666',
                            // method: 'gtag',
                            // prefix: 'ChatWidget',
                        },
                    },
                    }  
                },		
      }).then(client => window.TwinClient = client); 
    }; 
  })(); 
</script>

</body>
</html>



Подсказка
Нет необходимости подключать к виджету обе метрики одновременно. Подробнее о метриках см. Сбор статистики по действиям пользователей в виджете c помощью Яндекс метрикии Сбор статистики по действиям пользователей в виджете c помощью Google Analytics.