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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Переменные детектора эмоций

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

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

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

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

В зависимости от эмоциональной окраски ответа клиента бот может направить развитие диалога в ту или иную сторону:

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

Переменные детектора пола

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

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

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

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

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

• {детектор.пол}=male;
• {детектор.пол}=female.

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

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

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

{userName|падеж:родительный} - где userName, например: Иван Иванович.

Например, требуется задать вопрос: "Могу я услышать Ивана Ивановича?". Чтобы бот использовал значение переменной в родительном падеже, в сообщении, которое будет озвучено ботом в блоке "Вопрос", нужно указать следующее: "Могу я услышать {userName|падеж:родительный}?".

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

• Именительный (кто? что?) – пример: это кто? - Иван Иванович;
• Родительный (кого? чего?) – пример: нет кого? - Анны Андреевны или Ивана Ивановича;
• Дательный  (кому? чему?) – пример: кому вы рады? - Анне Андреевне и Ивану Ивановичу;
• Винительный (кого? что?) – пример: кого/что вы видите? - Ивана Ивановича или Анну Андреевну;
• Творительный  (кем? чем?) – пример: кем восхищаетесь? - Иваном Ивановичем и Анной Андреевной;
• Предложный (о ком? о чем?) – пример: о ком думаете? - об Иване Ивановиче и Анне Андреевне.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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