Функции

Техническая документация / Call-центр или Администрирование / Сценарии / Функции

Встроенная функция сценария осуществляет доступ к некоторым данным в момент выполнения сценария обработчиком.

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

• Оперирующие конкретным звонком и обслуживающей линией;
• Временные;
• Общие серверные (определяющие некоторые состояния системы);
• Специальные функции конкретного типа сценария.

Для задания функции сценария служит соответствующая вкладка окна Аргумент. Значение функции вычисляется в момент обработки сценария и подставляется в качестве аргумента текущего выполняемого объекта (свойства объекта) сценария.

Список встроенных функций сценариев.

В столбце типов указывается при редактировании каких типов сценариев доступна та или иная функция (IVR, Д-диалоговый, С-служебный)

Функция	Тип возвращ. значения	Типы сценариев (IVR, Д, С)	Описание
Id сессии сценария	Строка	Все	Текущий уникальный код сессии сценария (строковое представление GUID), в соответствии с которым осуществляется доступ к хранилищу глобальных переменных, формируются цепочки коммутаций при дозвоне.
Текущая дата	Дата/время	Все	Текущая дата.
Текущий год	Число	Все	Текущий год.
Текущий месяц	Число	Все	Текущий месяц.
Текущий день	Число	Все	Текущий день.
Текущий день недели	Число	Все	Текущий день недели (1-7).
Текущее время	Строка	Все	Текущее время.
Текущий час	Число	Все	Текущий час.
Текущая минута	Число	Все	Текущая минута.
Текущая секунда	Число	Все	Текущая секунда.
Номер абонента (CallerId)	Строка	IVR, Д	Для внешних линий - определитель номера абонента (если не определен – строка «Номер не определен»). Для внутренних линий (только в IVR) - номер пользователя, который обслуживается в сценарии. В качестве номера возвращается строка, начинающаяся с символа «U» и соответствующая прямому сервисному внутреннему номеру, назначенному на пользователя. Такие номера недоступны для набора непосредственно с телефона из-за спец.символов и используются только для служебных целей. Этот номер может быть подставлен в качестве аргумента в компоненты сценария, имеющие свойство «Внутренний номер получателя» (Уведомление, Голосовая почта и др.).
Набранный (внешний) номер (CalledId)	Строка	IVR, Д	Номер, по которому дозвонился абонент (актуально для потоков Е1). Если номер не определился – подставляется значение из свойства внешней линии. Для внутренних линий (только в IVR) - номер, по которому был осуществлен вход в текущий сценарий из АТС. При звонке с IP-телефона: если номер дозвона в АТС в начальных символах содержит внутренний номер для входа в сценарий, то в сценарии функция вернет всю последовательность. Например: номер сценария 25, на IP телефоне набрали 2511 CALL => функция вернет 2511.
XML-INFO абонента	Строка	IVR, Д	Строка, сформированная внешним приложением, и переданная вместе со звонком из собственного интеграционного модуля SipClient (подробнее в руководстве по интеграции, раздел «Звонок разработчику»). Может быть подвергнута разбору в сценарии и использована для проведения произвольной маршрутизации вызова. Вызов поступает на каналы шлюзов с типом регистрации Вхощящие из COM-клиента.
Guid-идентификатор пользователя	Строка	IVR	Строка, содержащая идентификатор пользователя, который обслуживается в сценарии.
Имя пользователя	Строка	IVR	Используется для внутренних линий всех типов, которые связаны с пользователем. Для остальных возвращает пустую строку. Имя обслуживаемого в сценарии пользователя.
Номер пользователя внутри АТС	Строка	IVR	Используется для внутренних линий всех типов. Для внешних возвращает пустую строку. Определяет внутренний стандартный номер, по которому можно дозвониться до обслуживаемой линии (и/или пользователя) - далее обслуживаемые объекты. Если во внутреннем номерном плане содержатся несколько номеров со ссылками на обслуживаемые объекты, то будет выбран негрупповой - тот, в списке ссылок которого присутствует единственный объект - обслуживаемый (линия или пользователь). Если негрупповой номер отсутствует, то преимущественно будет выбран групповой номер с наименьшим значением. (Из двух групповых номеров 203 и 405, будет выбран 203)
Тип линии	Строка	IVR, Д	Число, определяющее типа линии 1 - Внешняя аналоговая; 2 - Внутренняя аналоговая; 3 - VoIP канал; 4 - Внешняя GSM; 5 - IP; 6 - Канал потока Е1.
Guid-идентификатор линии	Строка	Все	Строка с guid-идентификтором обслуживаемой сценарием линии. В служебном сценарии функция возвращает непустое значение только в некоторых режимах, например при использовании сценария в качестве преобразователя callerid на входящих вызовах.
Номер линии	Строка	Все	Строка, определяющая номер линии по классификации АТС Oktell (11001, 15049 и т.п.), обслуживаемой текущим сценарием. Список линий и их номеров доступен в модуле Администрирование.Линии. В служебном сценарии функция возвращает непустое значение только в некоторых режимах, например при использовании сценария в качестве преобразователя callerid на входящих вызовах.
Код линии	Строка	Все	Строка с кодом линии, назначенным в модуле Администрирование.Линии. В служебном сценарии функция возвращает непустое значение только в некоторых режимах, например при использовании сценария в качестве преобразователя callerid на входящих вызовах.
Код направления	Строка	IVR	Строка, определяющая код первого найденного активного направления, в котором присутствует обслуживаемая IVR-сценарием линия. В случае, если линии назначены в несколько направлений и нужно уточнить принадлежность линии к определенному, лучше воспользоваться компонентом «Статус объекта».
Номер линии, ожидающей во Flash-буфере	Строка	IVR	В случае, если у обслуживаемой текущим сценарием линии во Flash буфере находится в ожидании некоторый абонент, то функция возвращает строку с номером ожидающей линии по классификации АТС Oktell. В противном случае возвращается пустая строка.
Номер линии, осуществившей переключение	Строка	IVR	В случае, если запущенный сценарий был переведен другой линией в результате использования Flash-удержания, возвращается строка с ее номером по классификации АТС Oktell. В остальных случаях возвращается пустая строка.
Название активного фонового IVR-сценария медиа-взаимодействия	Строка	IVR	В случае, если в настоящее время активен фоновый сценарий медиа-взаимодействия с текущей обслуживаемой линий, возвращает его название. Иначе возвращается пустая строка.
Время в текущем сценарии	Число	Все	Время в секундах, прошедшее после запуска непосредственно текущего сценария.
Время в обработчике сценариев	Число	Все	Время в секундах, прошедшее после запуска текущей сессии сценариев.
Название текущего сценария	Строка	Все	Название текущего выполняемого сценария
Тип соединения	Число	IVR, Д	1–Звонок с внутренней линии на внешнюю (Только диалоговый) 2–Звонок с внутренней линии в IVR 4–Звонок с внешней линии в IVR 5–Звонок с внешней линии на внутреннюю (Только диалоговый) 7–Звонок из IVR на внешнюю линию (из задачи) 8–Звонок из IVR на внутреннюю линию (из задачи)
Количество свободных внешних линий	Число	IVR, Д	Число свободных внешних линий, находящихся в активном состоянии.
Количество абонентов на набранном номере	Число	IVR, Д	Число абонентов, дозвонившихся на тот же номер, что и текущий абонент. Используется для обрубания вызовов по конкретным номерам при превышении лимита допустимого количества подключений.
Количество зарегистрированных операторов	Число	Все	Число операторов, находящихся в call-центре онлайн (в свободном и занятом режимах, исключая перерывы).
Количество свободных операторов	Число	Все	Число операторов, находящихся в call-центре в свободном состоянии, готовых обработать вызов незамедлительно.
Случайное число	Число	Все	Случайное число от 0 до 999999 (равномерное распределение).
Id оператора	Строка	Д	Идентификатор текущего оператора в виде «00000000-0000-0000-0000-000000000000». Необходимо помнить, что в ходе обработки сценария диалога операторы могут переключаться.
Имя оператора	Строка	Д	Имя текущего оператора.
Внутренний номер оператора (Uguid)	Строка	Д	Номер оператора, обслуживающего текущий звонок. Кодовое представление номера. Необходим для компонентов «Уведомление», «Определение статуса», и других, в которых требуется указание номера.
Хост оператора	Строка	Д	Имя компьютера оператора, обслуживающего текущий звонок.
Id проекта	Строка	Все	Идентификатор проекта текущей задачи, в ходе обработки которой был запущен сценарий.
Название проекта	Строка	Все	Название проекта текущей задачи, в ходе обработки которой был запущен сценарий.
Id задачи	Строка	Все	Идентификатор текущей задачи, в ходе обработки которой был запущен сценарий.
Код задачи	Строка	Все	Код текущей задачи, в ходе обработки которой был запущен сценарий.
Название задачи	Строка	Все	Название текущей задачи, в ходе обработки которой был запущен сценарий.
Параметр задачи	Число	Все	Параметр запуска сценария, переданный из задачи, куда попал в свое время в момент ее создания из компонента «Задание на звонок».
Id абонента в списке	Число	Все	Идентификатор абонента в прикрепленной таблице абонентов.
Id коммутации	Строка	IVR, Д	Уникальный идентификатор коммутации.
Id цепочки коммутаций	Строка	IVR, Д	Уникальный идентификатор звонка (сессии) внутри АТС Oktell.
Id sip-сессии	Строка	IVR	По умолчанию уникальный идентификатор sip-сессии из поля «Call-ID».
КС: идентификатор	Строка	С	При запуске служебного сценария для обработки контрольного события Guid-идентификатор контрольного события в строковом представлении.
КС: название	Строка	С	При запуске служебного сценария для обработки контрольного события название контрольного события.
КС: идентификатор задачи	Строка	С	При запуске служебного сценария для обработки контрольного события Guid-идентификатор задачи, в которой событие обнаружено, в строковом представлении.
КС: идентификатор оператора	Строка	С	При запуске служебного сценария для обработки контрольного события Guid-идентификатор оператора, совершившего контрольное событие, в строковом представлении
КС: показатель	Число	С	При запуске служебного сценария для обработки контрольного события числовой показатель соответствующего события.
КС: описание	Строка	С	При запуске служебного сценария для обработки контрольного события дополнительное текстовое поле с информацией о деталях события.
Инициатор запуска. Код типа	Строка	С	Определяет код модуля-иницатора запуска служебного сценария. 10 - Контрольное событие. 11 - Дозвон из задачи на внешний номер. 12 - Автодозвон на внешний номер. 13 - Строковое преобразование. 14 - Запуск по инициативе клиентского приложения (из модуля администрирования, из плагина, либо из внешнего интегрированного приложения). 15 - Набор быстрого номера. 16 - Набор экстренного номера. 17 - Набор внутреннего номера при приглашении в конференцию. 18 - Набор внутреннего номера из автодозвона. 19 - Прерывание вызова внутреннего номера в конференции. 20 - Обработка завершения конференции. 21 - Поиск абонента для голосовой задачи в режиме работы с таблицей абонентов через сценарий. 22 - Обработка завершения звонка/попытки звонка в голосовой задаче. 23 - Набор внешнего номера из конференции. 24 - Набор внешнего номера, указанного в стандартном внутреннем. 25 - Обработка завершения сессии внешнего канала (обработка контента линии по общему сценарию АТС). 26 - Обработка завершения сессии внешнего канала (обработка контента линии по сценарию задачи). 27 - Обработка веб-запроса к серверу на запуск сценария. 28 - Определение абонента при входящем вызове. 29 - Отправка SMS. 30 - Отправка E-mail.
Инициатор дозвона. Тип	Строка	С	Определяет название модуля-инициатора запуска служебного сценария в некоторых режимах. «КС» - контрольное событие. «Задача» - сценарий запущен как набор номера в задаче. «АДЗ» - сценарий запущен как набор номера в автодозвоне. «Быстрый» - сценарий запущен как набор быстрого/внешнего номера. «Экстренный» - сценарий запущен как набор экстренного номера. «Внутренний из конференции» - сценарий запущен как набор внутреннего номера из конференции. «Внутренний из АДЗ» - сценарий запущен как набор внутреннего номера из АДЗ. В других случаях возвращается пустая строка.
Инициатор дозвона. Идентификатор (задача/пользователь)	Строка	С	Для вышеприведенных типов запуска служебного сценария возвращает Guid-идентификатор в строковом представлении соответственно контрольного события, задачи, пользователя, запустившего автодозвон. В других случаях возвращается пустая строка.
Инициатор дозвона. Имя (задача/пользователь)	Строка	С	Для вышеприведенных типов запуска служебного сценария возвращает название соответственно контрольного события, задачи, пользователя, запустившего автодозвон. В других случаях возвращается пустая строка.
Инициатор дозвона. Внутренний номер (пользователь)	Строка	С	Для режима запуска служебного сценария в качестве набора номера в режиме автодозвона возвращает внутренний номер пользователя, инициировавшего автодозвон. В других случаях возвращается пустая строка.
Конференция. Идентификатор (Guid)	Строка	C	Задано при запуске сценариев, связанных с конференцией (набор номера, отмена, обработка завершения). Строковое представление GUID-идентификатора связанной конференции.
Конференция. Код идентификатора (Int32)	Число	C	Задано при запуске сценариев, связанных с конференцией (набор номера, отмена, обработка завершения). Число, являющееся довольно уникальной функцией от GUID-идентификатора связанной конференции. Может быть использовано для идентификации конференции при входе из IVR-сценария.
Конференция. Номер комнаты	Число	C	Задано при запуске сценариев, связанных с конференцией (набор номера, отмена, обработка завершения). Номер комнаты связанной конференции.
Конференция. Идентификатор участника (Guid)	Строка	C	Задано при запуске сценариев, связанных с конференцией (набор номера, отмена набора номера). GUID-идентификатор связанного участника связанной конференции. Применяется при организации внешней очереди для привязки звонка к конкретному участнику конференции, находящемуся в состоянии ожидания ответа.
Конференция. Код идентификатора участника (Int32)	Число	C	Задано при запуске сценариев, связанных с конференцией (набор номера, отмена набора номера). Число, являющееся довольно уникальной функцией от GUID-идентификатора связанного участника связанной конференции. Может быть использовано для идентификации конференции при входе из IVR-сценария.
Входной параметр 1	Строка	С	Входной параметр 1, передаваемый на старт служебного сценария. Совпадает с параметром, сохраняемым в компоненте «Старт».
Входной параметр 2	Строка	С	Входной параметр 2, передаваемый на старт служебного сценария. В сценариях преобразования CallerId содержит внешний номер (CalledId). Может быть установлен при запуске сценария по инициативе плагинов и внешнего ПО, подключенного через ядро клиентского уровня платформы. Также используется для передачи служебной информации при использовании служебных сценариев - триггеров, обработчиков, набора номера.
Входной параметр 3	Строка	С	Входной параметр 3, передаваемый на старт служебного сценария. Может быть установлен при запуске сценария по инициативе плагинов и внешнего ПО, подключенного через ядро клиентского уровня платформы. Также используется для передачи служебной информации при использовании служебных сценариев - триггеров, обработчиков, набора номера.
Входной параметр 4	Строка	С	Входной параметр 4, передаваемый на старт служебного сценария. Может быть установлен при запуске сценария по инициативе плагинов и внешнего ПО, подключенного через ядро клиентского уровня платформы. Также используется для передачи служебной информации при использовании служебных сценариев - триггеров, обработчиков, набора номера.
Входной параметр 5	Строка	С	Входной параметр 5, передаваемый на старт служебного сценария. Может быть установлен при запуске сценария по инициативе плагинов и внешнего ПО, подключенного через ядро клиентского уровня платформы. Также используется для передачи служебной информации при использовании служебных сценариев - триггеров, обработчиков, набора номера.