Якорь
geninfo geninfo

Общая информация

...

На платформе TWIN существуют

...

системные переменные, которые можно использовать в любом сценарии.

...

Системные переменные не нужно объявлять

...

и записывать в них данные – вы можете сразу использовать их в своих сценариях.

При указании переменных в

...

сообщениях блоков нужно использовать фигурные скобки

...

. Например, чтобы добавить в сценарий переменную

...

«системные.сегодня» укажите ее следующим образом: {системные.сегодня}.

Image Added

Подсказка

Помимо встроенных системных переменных пользователи также могут можно использовать в сценариях свои собственные переменные. Пользователи могут создавать переменные с различными именами. Имя переменной может быть любым. Однако, существует ограничение: имя переменной не должно содержать точку. Данный символ используется только в именах встроенных переменных. Например Примеры: Правильные варианты: {Новая_переменная}, {Новая_Переменная}, {новаяПеременная}. Неправильный вариант: {Новая.переменная}. Системные переменные

Якорь
geninfo2 geninfo2

Переменные группы «Системные»

В сценариях можно использовать следующие

...

переменные группы «Системные»:

{системные.сейчас}

...

Переменная {системные.сейчас}возвращает текущие дату и время по UTC (например, 2019-11-22 04:06:58). Текущие дата и время определяются

...

во время диалога с клиентом.

Подсказка
Для входящей телефонии и чатов данная переменная имеет аналог {now}. В исходящей телефонии аналог не работает.

Пример использования:

Клиент звонит в магазин.

Бот

...

произносит сообщение:

...

«Внимание! В течение этого месяца у нас проходит грандиозная распродажа! Цены снижены до 30%. Сегодня {системные.сейчас}. Торопитесь успеть!»

Image Added

Чтобы бот отображал время для конкретного часового пояса, нужно использовать дополнительный блок Арифметическая операция. Для параметра Тип нужно выбрать значение Дата. В поле Смещение от даты нужно ввести название системной переменной {системные.

...

Пример использования:

Клиент создает заказ и хочет узнать, когда он сможет его забрать.

Бот отвечает клиенту: заказ будет готов к получению сегодня {системные.сегодня}, начиная с 18.00.

...

сейчас} и задать смещение в секундах. Смещение происходит от текущего времени по UTC. То есть если вы хотите, чтобы бот указал текущее время, например, в Волгограде (UTC + 3), нужно задать смещение равное 10800 (количество секунд в 3 часах). Результат нужно сохранить в пользовательскую переменную. После этого пользовательскую переменную можно использовать в тексте сообщения.

Image Added

Image Added

...

{компания.сейчас}

Переменная {компания.сейчас}возвращает текущие дату и время с учетом часового пояса, в котором расположена компания (например, 2019-11-22 04:06:58).

...

Текущие дата и время определяются во время диалога с клиентом.

...

{системные.сегодня}

Переменная {системные.сегодня}возвращает текущую дату без указания времени (например, 2019-11-22). Текущая дата определяется во время диалога с клиентом.

Пример использования:

Клиент

...

создает заказ и хочет узнать, когда он сможет его забрать.

Бот отвечает клиенту:

...

«Заказ будет готов к получению {системные.

...

сегодня}

...

Image Removed

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

Пример использования:

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

...

Пример использования:

Например, можно настроить правило перезвона через блок "Результат".

...

Переменные детектора ({детектор.эмоций})

Детектор эмоций предназначен для определения эмоциональной окраски ответа клиента. Данная переменная доступна только для сценариев, которые используются в телефонии.

В системе существуют следующие переменные детектора эмоций: 

• {negativ}- негативная эмоциональная окраска;
• {positive}- позитивная эмоциональная окраска;
• {neutral}- нейтральная эмоциональная окраска.

Переменные детектора пола ({детектор.пол})

Детектор пола предназначен для определения пола клиента по его голосу. Данная переменная доступна только для сценариев, которые используются в телефонии.

В системе существуют следующие переменные детектора пола: 

• male - мужской;
• female - женский;
• unsure - система на смогла прийти к однозначному решению;
• unknown - не удалось определить пол или определение пола  выключено/не поддерживается;

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

{переменная|падеж:имя_падежа} 

Склонение переменных для правильного произношение синтезом согласно падежу.

Пример: {m_0|падеж:родительный} - где m_0, например: Иван Иванович. И согласно сценарию "могу я услышать m_0 ?", задача использовать переменную в родительном падеже.

Поддерживаются все падежи:

именительный                      (кто? что?)  пример: -это кто? -Иван Иванович

родительный                        (кого? чего?)   пример: -нет кого? - Анны Андреевны или Ивана Ивановича

дательный                            (кому? чему?)      пример: чему вы рады? -Анне Андреевне и Ивану Ивановичу

винительный                        (кого? что?)   пример: кого/что вы видите? -Ивана Ивановича или Анну Андреевну

творительный                     (кем? чем?)  пример: кем восхищаетесь? -Иваном Ивановичем и Анной Андреевной

предложный                           (о ком? о чем?)  пример: о ком думаете? - об Иване Ивановиче и Анне Андреевне

Переменные значения которых не меняются и которые нельзя изменить в процессе диалога

{companyId} - строка, идентификатор компании которой принадлежит бот.
{botId} - строка, идентификатор бота.
{dialogId} - строка, идентификатор текущего диалога.
{dialog} - объект, автоматически, при вставке в строку, трансформируется в текст диалога.
{referer} - строка, URL с которого пришёл пользователь (используется для чатов).
{utcNow} - текущее дата и время в часовом поясе UTC+0.
{utcTime} - текущее время в часовом поясе UTC+0.
{utcToday} - текущая дата в часовом поясе UTC+0.

Информация о клиенте (конечный пользователь Twin, участник диалога)

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

{clientId} - uuid, внутренний идентификатор клиента в системе Twin.
{clientPhone} - строка, номер телефона клиента.
{clientEmail} - строка, адрес электронной почты клиента.
{clientName} - строка, имя клиента.
{clientNickname} - строка, псевдоним клиента.
{clientExternalId} - строка, внешний идентификатор клиента в системе, который может задавать при старте диалога.
{clientMetadata} - массив, любые данные о клиенте.

Данные, которые можно изменить только в процессе переключения со звонка на чат, либо наоборот

(Пока данный функционал не доступен в полном объеме, т.к. не запущен CIS. В данный момент можно использовать, например для определения в каком мессенджере ведется диалог):

{communicationType} - строка, тип коммуникации с клиентом. Допустимые значения: TEXT, VOICE.
{channelType} - строка, тип канала общения. Допустимые значения: WEB, MOBILE, MESSENGER.
{messenger} - строка, тип мессенджера. Допустимые значения: WHATSAPP, VIBER, TELEGRAM, VKONTAKTE, FACEBOOK, SKYPE, SLACK, YANDEX, ALICE, THREADS.

Данные, меняющиеся при каждом обращении к боту, автоматически

{percept} - строка, хранит фразу которую сказал пользователь и на которую в данный момент отвечает бот.
{clientLastAnswerTime} - целое число, время последней фразы клиента в секундах.
{botLastAnswerTime} - целое число, время последнего ответа бота в секундах.

Переменные будут пополняться в этой статье по мере их появления на нашей платформе

...

There are built-in variables on the TWIN platform that can be used in various scenarios:

Unfortunately, it is not possible to use your own dot variables:

{your.variable}

this construction will not work. This is the only limitation in variables, since "." points to a system variable.

{system.variable}

System variables used on the platform.

{system.now}, the analogue is a variable {now} - Date with time (for example 2019-11-22 04:06:58). The current date is used when the script was used.

{system.today}, the analogue is a variable {today} - Date without time (for example, 2019-11-22). The current date is used when the script was used.

{system.time}, the analogue is a variable {time} Time without date (for example 04:06:58). The current time is used at the moment of using the script.

{system.telephone} Subscriber’s number used in the script when making a call via phone.

{system.previous} Script number. You can use such conditions during the transition between scripts to know where the transition was made from.

{system.dial} Counter of successful calls to the candidate within the call task.

{system.record} Sends a link to a sound recording of the current conversation via phone (Now only on the TWIN platform, the recording format is .mp3).

{detector.emotions}

Determination of the emotional coloring of a person's answer. There are 3 types: 

• negative - Negative coloring
• positive - Positive coloring
• neutral - Neutral emotionality

{detector.gender}

Determination of gender by voice. Only available in calls. For this variable to work, it is required to check "Determination of gender characteristic" in the call task. Possible values

To determine the gender, the system needs at least 1 second of the client's clear voice, otherwise the system will not recognize anything.

• male. -male
• female - female
• unsure - the system could not come to an unambiguous decision
• unknown - could not be detected or emotion detection is disabled / not supported

Variable values of which do not change and which cannot be changed during the dialogue

{companyId} is a string, company ID which the bot belongs to.

{botId} is a string, bot ID.

{dialogId} is a string, current dialog ID.

{dialog} is an object, when inserting into a line, is automatically transformed into the dialog text.

{referer} is a string, URL where the user came from (used for chats)

Client information (Twin end user, dialogue participant)

information can be changed during the dialogue using the client identification endpoint (it is available both in chats and in the bot service).

{clientId} is a string, client ID in Twin system.

{clientPhone} is a string, client phone number.

{clientEmail} is a string, client email address.

{clientName} is a string, client name.

{clientNickname} is a string, client nickname.

{clientExternalId} is a string, user ID in the Twin client system, must be unique within the company.

{clientMetadata} is an array, any data about the client.

Data that can be changed only when switching from a call to a chat, or vice versa

(So far, this functionality is not available in full, because CIS has not been launched. At the moment, you can use it, for example, to determine in which messenger the dialogue is being conducted):

{communicationType} is a string, client communication type. Valid values: TEXT, VOICE.
{channelType} is a string, communication channel type. Valid values: WEB, MOBILE, MESSENGER.
{messenger} is a string, messenger type. Valid values: WHATSAPP, VIBER, TELEGRAM, VKONTAKTE, FACEBOOK, SKYPE, SLACK, YANDEX, ALICE, THREADS.

Data that changes automatically with each addressing to the bot

{percept} is a string that stores a phrase said by the user and which the bot is currently responding to.
{clientLastAnswerTime} is an integer, time of the client's last phrase in seconds.
{botLastAnswerTime} is an integer, the time of the last bot's response in seconds.

, начиная с 18.00».

Image Added

Чтобы бот вместе с датой отображал еще и время, нужно использовать блок Арифметическая операция. Для параметра Тип нужно выбрать значение Дата. В поле Смещение от даты нужно ввести название системной переменной {системные.сегодня} и задать смещение в секундах. Смещение происходит от начала суток (00.00). То есть если вы хотите, чтобы бот отобразил текущую дату и указал время, например, 9.00, нужно задать смещение равное 32400 (количество секунд в 9 часах). Результат нужно сохранить в пользовательскую переменную. После этого пользовательскую переменную можно использовать в тексте сообщения.

Image Added

Image Added

...

{компания.сегодня}

Переменная {компания.сегодня}возвращает текущую дату без указания времени (например, 2019-11-22). При этом учитывается часовой пояс, в котором расположена компания. Текущая дата определяется во время диалога с клиентом.

...

{системные.время}

Переменная {системные.время} возвращает текущее время без указания даты (например, 04:06:58). Текущее время определяется во время диалога с клиентом.

Пример использования:

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

Бот отвечает клиенту: «Посадка на рейс в Лондон заканчивается в 18.45. Сейчас: {системные.время}».

...

{компания.время}

Переменная {компания.время} возвращает текущее время без указания даты (например, 04:06:58). При этом учитывается часовой пояс, в котором расположена компания. Текущее время определяется во время диалога с клиентом.

{системные.телефон}

Переменная {системные.телефон} возвращает номер телефона клиента, который указан в задании на обзвон для выполнения вызова.

Пример использования:

Клиент звонит в магазин, чтобы узнать срок действия заказа.

Бот отвечает клиенту: «Уточните, заказ оформлен на номер {системные.телефон}?» После завершения разговора бот отправляет шаблонное SMS-сообщение с информацией о заказе на номер клиента:

Image Added

...

{системные.предыдущий}

Переменная {системные.предыдущий} возвращает ID сценария, из которого система перенаправила бота в другой сценарий во время диалога с пользователем (также см. Как перевести диалог бота с клиентом в другой сценарий).

Пример использования:

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

...

{системные.дозвон}

Переменная {системные.дозвон} возвращает количество дозвонов до кандидата в рамках задания на обзвон. Считаются все результативные звонки по номеру кандидата.

Пример использования.

{tryNumber}

Переменная {tryNumber} возвращает количество попыток дозвона в рамках задания на обзвон. Используется в телефонии CIS.

{userAnswer}

Переменная {userAnswer} используется для хранения ответа пользователя, который применяется к блоку вопроса при включенной опции Использовать ответ пользователя. Эта переменная позволяет системе сохранить и использовать ответ пользователя для дальнейшего анализа и обработки.

{системные.запись}

Переменная {системные.запись} возвращает ссылку на аудиозапись текущего диалога в телефонии. Переменная используется только в исходящих вызовах.

{recordPath}

Переменная {recordPath} содержит ссылку на скачивание аудиозаписи текущего диалога. Используется в телефонии CIS.

Якорь
unchangable unchangable

Переменные, значения которых не меняются в процессе диалога

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

• {companyId} – возвращает строку с идентификатором компании, которой принадлежит бот.
• {botId} – возвращает строку с идентификатором бота.
• {dialogId} – возвращает строку с идентификатором текущего диалога.
• {dialog} – возвращает строку с полным текстом диалога.
• {referer} – возвращает строку с адресом главной страницы сайта, на которой размещен виджет (позволяет оператору понять, с какого сайта пишет пользователь).
• {utcNow} – возвращает текущие дату и время в часовом поясе по UTC.
• {utcTime} – возвращает текущее время в часовом поясе по UTC.
• {utcToday} – возвращает текущую дату в часовом поясе по UTC
• {messengerUserId} – возвращает идентификатор учетной записи пользователя в мессенджере.

Пример использования:

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

Image Added

Якорь
uservar uservar

Переменные с информацией об участнике диалога

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

• {clientId} – возвращает строку с внутренним идентификатором клиента в системе TWIN (uuid).
• {clientPhone} – возвращает строку с номером телефона клиента.
• {clientEmail} – возвращает строку с адресом электронной почты клиента.
• {clientName} – возвращает строку с именем клиента.
• {clientNickname} – возвращает имя клиента (никнейм) в мессенджере, в котором клиент общался с ботом.
• {clientExternalId} – возвращает строку с внешним идентификатором клиента в системе.
• {clientMetadata} – возвращает массив, содержащий любые данные о клиенте (задается в следующем формате:  {"{firstName}": "Иван", "{middleName}": "Иванович", "{lastName}": "Иванов"}.

Значения данных переменных бот может получать по различным каналам связи (например, Viber, WhatsApp, Telegram и др.).  Чтобы изменить значение любой из этих переменных, нужно определить соответствующую переменную в сценарии.

Image Added

Якорь
chang chang

Переменные, значения которых можно изменить только при переключении со звонка на чат и наоборот

• {communicationType} – строка, тип коммуникации с клиентом. Допустимые значения: TEXT, VOICE;
• {channelType} – строка, тип канала общения. Допустимые значения: WEB, MOBILE, MESSENGER;
• {messenger} – строка, тип мессенджера. Допустимые значения: WHATSAPP, VIBER, TELEGRAM, VKONTAKTE, FACEBOOK*, SKYPE, SLACK, YANDEX, ALICE, THREADS, AVITO.

Пример использования:

Во время диалога бот может уточнить у клиента, удобно ли ему общаться в текущем мессенджере. Впоследствии бот может перевести диалог на телефон.

Image Added

Якорь
chang2 chang2

Переменные, значения которых меняются при каждом обращении к боту

• {percept} – возвращает строку с последним ответом клиента на вопрос бота.
• {clientLastAnswerTime} – возвращает время последнего ответа пользователя на вопрос бота. Значение отображается в виде временной метки Unix-времени.
• {botLastAnswerTime} – возвращает время последнего ответа бота в секундах. Значение отображается в виде временной метки Unix-времени.

Данные переменные используются для входящей телефонии и в чатах в основном для отладочных целей.

• {channelType} – строка, тип канала общения. Допустимые значения: WEB, MOBILE, MESSENGER.
• {messenger} – строка, тип мессенджера. Допустимые значения: WHATSAPP, VIBER, TELEGRAM, VKONTAKTE, FACEBOOK*, SKYPE, SLACK, YANDEX, ALICE, THREADS, AVITO.

Якорь
форматеры форматеры

Средства форматирования даты и времени

При помощи программных средств можно отображать дату и время в желаемом формате. Например, клиент может написать в диалоге следующую фразу: «третьего октября в восемь». Ответ клиента можно сохранить в переменную, а в дальнейшем (при необходимости) отобразить в диалоге в нужном виде, например:  2022-10-03 в 08:00, 08:00 03-10, 22-10-03, 03.10.22, в 08:00, 08:00 АМ, Monday и др.

По умолчанию дата и время отображаются в сценариях в следующих форматах:

• Дата: ГГГГ-ММ-ДД
• Время: ЧЧ:ММ:СС
• Дата и время: ГГГГ-ММ-ДД ЧЧ:ММ:СС

Для форматирования дат и времени служит следующий шаблон: {<имя переменной>|формат: код или коды форматирования}.

Список кодов форматирования:

Вы можете использовать одновременно несколько кодов форматирования из списка выше. В качестве разделителя можно использовать различные символы: точка, запятая, точка с запятой, двоеточие, плюс, минус и др. В строке форматирования также можно использовать различные слова и фразы. Например:

Якорь
varlist varlist

Полный список переменных

Системные переменные

• {системные.сейчас} возвращает текущие дату и время по UTC (например, 2019-11-22 04:06:58).
• {компания.сейчас} возвращает текущие дату и время с учетом часового пояса, в котором расположена компания (например, 2019-11-22 04:06:58).
• {системные.сегодня} возвращает текущую дату без указания времени (например, 2019-11-22).
• {компания.сегодня} возвращает текущую дату без указания времени (например, 2019-11-22). При этом учитывается часовой пояс, в котором расположена компания.
• {системные.время} возвращает текущее время без указания даты (например, 04:06:58).
• {компания.время} возвращает текущее время без указания даты (например, 04:06:58). При этом учитывается часовой пояс, в котором расположена компания.
• {системные.телефон} возвращает номер телефона клиента, который указан в задании на обзвон для выполнения вызова.
  
• {системные.предыдущий} возвращает ID предыдущего сценария, из которого система во время диалога с пользователем перенаправила бота в другой сценарий.
• {системные.дозвон} возвращает количество дозвонов до кандидата в рамках задания на обзвон. Считаются все результативные звонки по номеру кандидата.
• {tryNumber} количество попыток дозвона по номеру кандидата, считается с 0. Аналог {системные.попытка}.
• {системные.запись} возвращает ссылку на аудиозапись текущего диалога в телефонии.
• {системные.расшифровка} – возвращает строку с полным текстом диалога.
• {recordPath} возвращает ссылку на скачивание аудиозаписи текущего диалога в телефонии CIS.
• {системные.попытка} считаются все попытки дозвона по номеру кандидата.
• tryCandidate - количество попыток дозвона до кандидата, считается с 0.
• answeredCandidate - количество дозвонов до кандидата, считается с 0.
• resultCandidate - количество результативных дозвонов до кандидата, считается с 0.
• humanCandidate - количество дозвонов до кандидата, где ответивший был НЕ автоответчик, считается с 0.
• answeredNumber - количество дозвонов по номеру кандидата, считается с 0.
• humanNumber - количество дозвонов по номеру кандидата, где ответивший был НЕ автоответчик, считается с 0.
• resultNumber - количество результативных дозвонов по номеру кандидата, считается с 0. Аналог {системные.дозвон}.

Склонение значений пользовательских переменных по падежам

• {переменная|падеж:имя_падежа} – формат записи имен пользовательских переменных, который позволяет склонять их значения по падежам.

Переменные, значения которых не меняются в процессе диалога

• {companyId} – возвращает строку с идентификатором компании, которой принадлежит бот.
• {botId} – возвращает строку с идентификатором бота.
• {dialogId} – возвращает строку с идентификатором текущего диалога.
• {dialog} – возвращает строку с полным текстом диалога.
• {referer} – возвращает строку с адресом главной страницы сайта, на которой размещен виджет (позволяет понять, с какого сайта пишет пользователь).
• {utcNow} – возвращает текущие дату и время в часовом поясе по UTC.
• {utcTime} – возвращает текущее время в часовом поясе по UTC.
• {utcToday} – возвращает текущую дату в часовом поясе по UTC.

Переменные с информацией об участнике диалога

• {clientId} – возвращает строку с внутренним идентификатором клиента в системе TWIN (uuid).
• {clientPhone} – возвращает строку с номером телефона клиента.
• {clientEmail} – возвращает строку с адресом электронной почты клиента.
• {clientName} – возвращает строку с именем клиента.
• {clientNickname} – возвращает строку с псевдонимом клиента.
• {clientExternalId} – возвращает строку с внешним идентификатором клиента в системе.
• {clientMetadata} – возвращает массив, содержащий любые данные о клиенте (задается в следующем формате:  {"{firstName}": "Иван", "{middleName}": "Иванович", "{lastName}": "Иванов"}.

Переменные, значения которых можно изменить только при переключении со звонка на чат и наоборот

• {communicationType} – строка, тип коммуникации с клиентом. Допустимые значения: TEXT, VOICE.

Переменные, значения которых меняются при каждом обращении к боту

• {percept} – возвращает строку с последним ответом клиента на вопрос бота.
• {clientLastAnswerTime} – возвращает время последнего ответа пользователя на вопрос бота. Значение отображается в виде временной метки Unix-времени.
• {botLastAnswerTime} – возвращает время последнего ответа бота в секундах. Значение отображается в виде временной метки Unix-времени.

...

...