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

Ключ

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

...

...

Блок кода
languagejs
linenumberstrue
TwinChat.init('#twin-chat-container', {
            chatId: '35a40e2c-4955-4ae3-a8e0-559fd4381244',
            sessionDefaults: {
                name: 'Диалог с клиентом',
                clientExternalId: 'externalKey',
                clientMetadataclientEmail: {'client@mail.ru',
                    ageclientPhone: 31'79111234567',
                    topicclientName: "Открытие магазина"'Иван',
                    cityorderNumber: 'Москва1234567',
                 }clientDeviceId: '0000-1111-2222-3333-44444444',
                clientEmailclientTimezone: 'client@mail.ru-300',
            },
        clientPhone    appearance: '79111234567',{
                clientNamelang: 'Иванen',
                orderNumberstart: '1234567',{
                clientDeviceId    mode: '0000-1111-2222-3333-44444444messengerButtons',
                clientTimezone: '-300'},
            },
    rating: {
       appearance: {
            midterm: 'Оцените, как проходит lang: 'enдиалог',
                start:}
 {
               analytics: {
    mode: 'messengerButtons',
               yandexMetrika: },{
                   rating: {
    counter: '86962928',
               midterm: 'Оцените, как проходит диалог',
     // method: 'ym',
         }
               // analyticsprefix: {'/chat-widget',
                    yandexMetrika: {},
                    {
    counter: '86962928',
                   googleAnalytics: {
    // method: 'ym',
                        // prefixcounter: '/chat-widget88777666',
                     },
       // method: 'gtag',
           {
                 // prefix: 'ChatWidget',
     googleAnalytics: {
                   },
                   counter: '88777666'},
                }





TwinChat.init('#twin-chat-container', {
           // methodchatId: 'gtag35a40e2c-4955-4ae3-a8e0-559fd4381244',
            sessionDefaults: {
               // prefixname: 'ChatWidgetДиалог с клиентом',
                clientExternalId: 'externalKey',
             },
   clientMetadata: {
                    age: }31,
                 }

Объект sessionDefaults  передает в сценарий виджета системные и пользовательские переменные (например, ФИО клиента, день недели, контактный номер телефона, идентификатор клиента во внешней системе). Данные переменные можно использовать в диалогах виджета.

В указанном выше фрагменте кода используются следующие переменные:

...

  • yandexMetrika – имя используемой метрики;
    • counter – идентификатор яндекс метрики;
    • method – метод, который нужно вызывать при инициализации виджета. Можно использовать любой метод. По умолчанию применяется метод 'ym';
    • prefix – пространство имен для идентификации событий виджета в отчетах Яндекс.Метрики. По умолчанию используется значение 'chat-widget'.
  • googleAnalytics – имя используемой метрики;
    • counter – идентификатор метрики Google Analytics;
    • method – метод, который нужно вызывать при инициализации виджета. Можно использовать любой метод. По умолчанию применяется метод 'gtag';
    • prefix – пространство имен для идентификации событий виджета в отчетах Google Analytics. По умолчанию используется значение 'chatWidget'.
    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 (пользовательская переменная)– часовой пояс.
  • analytics – содержит свойства, которые позволяют подключить яндекс метрику для оценки частоты использования чата:
    • yandexMetrika – имя используемой метрики;
      • counter – идентификатор яндекс метрики;
      • method – метод, который нужно вызывать при инициализации виджета. Можно использовать любой метод. По умолчанию применяется метод 'ym';
      • prefix – пространство имен для идентификации событий виджета в отчетах Яндекс.Метрики. По умолчанию используется значение 'chat-widget'.
    • googleAnalytics – имя используемой метрики;
      • counter – идентификатор метрики Google Analytics;
      • method – метод, который нужно вызывать при инициализации виджета. Можно использовать любой метод. По умолчанию применяется метод 'gtag';
      • prefix – пространство имен для идентификации событий виджета в отчетах Google Analytics. По умолчанию используется значение 'chatWidget'.
Подсказка
Подробнее о метриках см. Сбор статистики по действиям пользователей в виджете c помощью Яндекс.Метрикии Сбор статистики по действиям пользователей в виджете c помощью Google Analytics.

Чтобы применить указанные выше настройки виджета, необходимо добавить объекты sessionDefaults,appearance и analytics в код инициализации виджета.

Подсказка

Ниже указано место размещения фрагмента кода с объектами sessionDefaults,appearance и analyticsв код инициализации виджета:

Image Added

Якорь
variables
variables

Использование переменных для передачи имени, номера мобильного телефона и адреса электронной почты клиента в диалоге

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

Переменные создаются в блоке инициализации виджета с помощью объекта sessionDefaults. Давайте создадим следующие переменные:

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

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

Блок кода
languagejs
linenumberstrue
TwinChat.init('#twin-chat-container', {
            chatId: '35a40e2c-4955-4ae3-a8e0-559fd4381244',
            sessionDefaults: {
                name: 'Диалог с клиентом',
                clientExternalId: 'externalKey',
                clientEmail: 'client@mail.ru',
                clientPhone: '79111234567',
                clientName: 'Иван',
            },

Чтобы добавить переменные в виджет, скопируйте представленны

Для этого добавьте к код инициализации виджета следующий фрагмент кодаЖ

Виджет имеет настройки, которые задаются при помощи объектов sessionDefaults, appearance и analytics. Ниже приводится фрагмент кода с этими объектами.


Блок кода
languagejs
linenumberstrue
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',
                        },
                    },
                }

...

Image Removed

...

Использование переменных для передачи имени, номера мобильного телефона и адреса электронной почты клиента в диалоге

...

 


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

...