На платформе существуют системные переменные, которые можно использовать в любом сценарии. Системные переменные не нужно объявлять и записывать в них данные — вы можете сразу использовать их в своих сценариях.
При указании переменных использовать фигурные скобки необходимо только при указании переменных в сообщениях, которые воспроизводятся ботом. В остальных случаях фигурные скобки не используются.
| Название | Описание |
|---|---|
{now} |
В звонке переменная возвращает дату и время в соответствии с часовым поясом номера клиента, а в чате — по всемирному времени UTC. |
{dialogId} |
Возвращает строку с идентификатором текущего диалога. |
{dialog} |
Возвращает строку с полным текстом диалога. |
{previousBotId} |
Возвращает ID сценария, из которого система перенаправила бота в другой сценарий во время диалога с пользователем. |
{today} |
Возвращает дату без указания времени (например, 2023-11-16). Текущая дата определяется во время диалога с клиентом. |
{time} |
Возвращает время абонента без указания даты (например, 15:53:12). В чате время определяется по UTC+0, в звонке — по часовому поясу абонента. |
{phone} |
Возвращает номер телефона клиента, с которым бот общается в данный момент. Переменная работает как для исходящих, так и для входящих вызовов, и содержит номер, который используется в текущем звонке. |
{recordPath} |
Возвращает ссылку на аудиозапись текущего диалога в телефонии. |
{percept} |
Возвращает строку с последним ответом клиента на вопрос бота. |
{tryNumber} |
Возвращает количество попыток дозвона в рамках задания на обзвон. |
{company.now} |
Возвращает дату и время с учетом часового пояса, в котором расположена компания (например, 2023-11-17 13:06:58). Текущие дата и время определяются во время диалога с клиентом. |
{company.today} |
Возвращает дату без указания времени (например, 2023-11-17). При этом учитывается часовой пояс, в котором расположена компания. Текущая дата определяется во время диалога с клиентом. |
{company.time} |
Возвращает время без указания даты (например, 13:06:58). При этом учитывается часовой пояс, в котором расположена компания. Текущее время определяется во время диалога с клиентом. |
{companyId} |
Возвращает строку с идентификатором компании, которой принадлежит бот. |
{botId} |
Возвращает строку с идентификатором бота. |
{referer} |
Возвращает строку с адресом главной страницы сайта, на которой размещен виджет (позволяет оператору понять, с какого сайта пишет пользователь). |
{utcNow} |
Возвращает дату и время в часовом поясе по UTC. |
{utcTime} |
Возвращает время в часовом поясе по UTC. |
{utcToday} |
Возвращает дату в часовом поясе по UTC. |
{messengerUserId} |
Возвращает идентификатор учетной записи пользователя в мессенджере. |
{communicationType} |
Строка, тип коммуникации с клиентом. Допустимые значения: TEXT, VOICE. |
{channelType} |
Строка, тип канала общения. Допустимые значения: WEB, MOBILE, MESSENGER. |
{messenger} |
Строка, тип мессенджера. Допустимые значения: WHATSAPP, VIBER, TELEGRAM, VKONTAKTE, FACEBOOK1, SKYPE, SLACK, YANDEX, ALICE, THREADS. |
{clientLastAnswerTime} |
Возвращает время последнего ответа пользователя на вопрос бота. Значение отображается в виде временной метки Unix-времени2. |
{botLastAnswerTime} |
Возвращает время последнего ответа бота в секундах. Значение отображается в виде временной метки Unix-времени2. |
{clientId} |
Возвращает строку с внутренним идентификатором клиента в системе TWIN (uuid). |
{clientPhone} |
Возвращает строку с номером телефона клиента. |
{clientEmail} |
Возвращает строку с адресом электронной почты клиента. |
{clientName} |
Возвращает строку с именем клиента. |
{clientNickname} |
Возвращает имя клиента (никнейм) в мессенджере, в котором клиент общался с ботом. |
{clientExternalId} |
Возвращает строку с внешним идентификатором клиента в системе. |
{clientMetadata} |
Массив, содержащий любые данные о клиенте (задается в следующем формате: {«{firstName}»: «Иван», «{middleName}»: «Иванович», «{lastName}»: «Иванов»}). |
{tryCandidate} |
Количество попыток дозвона до кандидата, считается с 0. |
{answeredCandidate} |
Количество дозвонов до кандидата, считается с 0. |
{resultCandidate} |
Количество результативных дозвонов до кандидата, считается с 0. |
{humanCandidate} |
Количество дозвонов до кандидата, где ответивший был не автоответчик, считается с 0. |
{answeredNumber} |
Количество дозвонов по номеру кандидата, считается с 0. |
{humanNumber} |
Количество дозвонов по номеру кандидата, где ответивший был не автоответчик, считается с 0. |
{resultNumber} |
Количество результативных дозвонов по номеру кандидата, считается с 0. |
1Деятельность организации Meta Platforms Inc. и ее продуктов Instagram и Facebook запрещена в Российской Федерации.
2Временная метка Unix-времени (например, 1658125300) отображает количество секунд, которое прошло с 1 января 1970 года (00:00:00 UTC).
{переменная|падеж:имя_падежа} – формат записи имен пользовательских переменных, который позволяет склонять их значения по падежам.
Пример использования:
{userName|падеж:родительный} – где userName, например: Иван Иванович.
Например, требуется задать вопрос: «Могу я услышать Ивана Ивановича?». Чтобы бот использовал значение переменной в родительном падеже, в сообщении, которое будет озвучено ботом в блоке Вопрос, нужно указать следующее: «Могу я услышать {userName|падеж:родительный}?»
Поддерживаются все падежи:
Именительный (кто? что?) – пример: «это кто?» – «Иван Иванович»;
Родительный (кого? чего?) – пример: «нет кого?» – «Ивана Ивановича»;
Дательный (кому? чему?) – пример: «кому вы рады?» – «Ивану Ивановичу»;
Винительный (кого? что?) – пример: «кого/что вы видите?» – «Ивана Ивановича»;
Творительный (кем? чем?) – пример: «кем восхищаетесь?» – «Иваном Ивановичем»;
Предложный (о ком? о чем?) – пример: «о ком думаете?» – об «Иване Ивановиче».