Якорь
geninfo geninfo

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

На платформе TWIN есть встроенные существуют системные переменные, которые можно использовать в различных сценариях:

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

{ваша.переменная}

такая конструкция работать не будет. Это единственное ограничение в переменных, так как знак "." указывает на системную переменную.

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

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

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

Image Added

Якорь
geninfo2 geninfo2

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

В сценариях можно использовать следующие переменные группы «Системные»:

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

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

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

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

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

Image Added

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

Image Added

Image Added

...

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

Переменная {компания.сейчас}возвращает текущие дату и время с учетом часового пояса, в котором расположена компания (например, Системные переменные используемые на платформе.
{системные.сейчас} - Дата со временем (например 2019-11-22 04:06:58). Используется текущая дата в момент использования сценария.
{системные.сегодня} - Дата без времени (например ). Текущие дата и время определяются во время диалога с клиентом.

...

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

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

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

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

Бот отвечает клиенту: «Заказ будет готов к получению {системные.сегодня}, начиная с 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 сценария, из которого система перенаправила бота в другой сценарий во время диалога с пользователем (также см. Как перевести диалог бота с клиентом в другой сценарий).

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

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

...

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

Переменная Номер сценария. Во время перехода между скриптами можно задействовать такое условия, чтобы знать откуда был сделан переход.
{системные.дозвон}  Счётчик успешных возвращает количество дозвонов до кандидата в рамках задания на обзвон. Считаются все результативные звонки по номеру кандидата.

...

{детектор.эмоции}

Определение эмоциональной окраски ответа человека. Бывает 3-х типов: 

• negative - Негативный окрас
• positive - Позитивный окрас
• neutral - Нейтральная эмоциональность

{детектор.пол}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

...

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

{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-времени.

Информация
Временная метка Unix-времени (например, 1658125300) отображает количество секунд, которое прошло с 1 января 1970 года (00:00:00 UTC).

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

Подсказка
Список переменных будет обновляться по мере появления новых переменных на платформе TWIN.

• {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-времени.