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

Ключ

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


Russian

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

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

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

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

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

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

Подсказка

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

Например:

  • Правильные варианты: {Новая_переменная}, {Новая_Переменная}, {новаяПеременная}.
  • Неправильный вариант: {Новая.переменная}.

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

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

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

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

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

.

Информация

На данный момент переменную {системные.запись} можно использовать только в личном кабинете пользователя Twin. Формат файла записи: ".mp3".

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

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

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

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

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

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

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

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

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

Пример: {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} - целое число, время последнего ответа бота в секундах.

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

...