Компонент Монитор

Описание

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

Table 1. Системные характеристики

Индекс

146

Краткое название

monitor

Типы сценариев

Все

Стартовый модуль

r_script_component_monitor

Режим

Асинхронный

Иконка

146

Характер разветвления

Разветвляющий, замыкающий

Свойства

Table 2. Свойства
Спецификация Описание

Название: Категория запроса
Код: category
Усл. видимости: нет
По умолчанию: Учетные записи

Выбор группы функций.
Возможные значения:

  • Учетные записи (acc, 1) – Информация по учетным записям и их состояниям.

  • Звонки (calls, 2) – Информация по активным звонкам.

  • Ханты (hunt, 3) – Информация по хант-группам и состояниям входящих в них агентам.

  • Очереди (huntq, 4) – Информация по очередям и составу ожидающих в них объектам/заданиям.

  • Сценарии (script, 5) – Информация по исполняющимся сценариям.

  • Селекторы (selector, 6) – Информация по активным селекторным совещаниям и их участникам.

  • Текстовые сессии (session, 7) – Информация по активным текстовым сессиям.

  • Система (system, 8) – Информация по системе.

Название: Метод
Код: method_acc
Усл. видимости: нет
По умолчанию: Провайдеры SIP

Выбор функции для категории Учетные записи.
Возможные значения:

  • Провайдеры SIP (provider, 1) – Возвращает совокупную информацию по состояниям учетных записей SIP-провайдеров текущего домена в виде JSON-структуры.

  • SIP-пользователи (sipuser, 2) – Возвращает совокупную информацию по состояниям учетных записей SIP-пользователей текущего домена в виде JSON-структуры.

  • Пользователи (user, 3) – Возвращает совокупную информацию по состояниям учетных записей пользователей текущего домена в виде JSON-структуры.

Название: Метод
Код: method_calls
Усл. видимости: нет
По умолчанию: Инфо

Выбор функции для категории Звонки.
Возможные значения:

  • Инфо (info, 1) – Возвращает совокупную информацию по активным звонкам текущего домена в виде JSON-структуры.

  • Диаграмма активности (diagram, 2) – Возвращает диаграмму по звонку/смежным звонкам. Звонки указываются перечислением CallId, автоматически производится замыкание (пополнение всеми CallId всех плеч связанных переводами звонков). В зависимости от выбранного режима возвращает содержание или путь к файлу, формат svg или plantuml.

Название: Метод
Код: method_hunt
Усл. видимости: нет
По умолчанию: SIP

Выбор функции для категории Ханты.
Возможные значения:

  • SIP (sip, 1) – Возвращает совокупную информацию по хант-группам типа sip текущего домена и состояниям их агентов в виде JSON-структуры.

  • Пользователи (usr, 2) – Возвращает совокупную информацию по хант-группам типа user текущего домена и состояниям их агентов в виде JSON-структуры.

Название: Метод
Код: method_huntq
Усл. видимости: нет
По умолчанию: SIP

Выбор функции для категории Очереди.
Возможные значения:

  • SIP (sip, 1) – Возвращает совокупную информацию по очередям типа sip текущего домена и состояниям ожидающих в них объектам в виде JSON-структуры.

  • Пользователи (usr, 2) – Возвращает совокупную информацию по очередям типа sip текущего домена и состояниям ожидающих в них объектам в виде JSON-структуры.

Название: Метод
Код: method_script
Усл. видимости: нет
По умолчанию: Инфо

Выбор функции для категории Сценарии.
Возможные значения:

  • Инфо (info, 1) – Возвращает совокупную информацию по активным выполняющимся сценариям текущего домена в виде JSON-структуры.

Название: Метод
Код: method_selector
Усл. видимости: нет
По умолчанию: Инфо

Выбор функции для категории Селекторы.
Возможные значения:

  • Инфо (info, 1) – Возвращает совокупную информацию по активным селекторным совещаниям текущего домена в виде JSON-структуры.

Название: Метод
Код: method_session
Усл. видимости: нет
По умолчанию: Инфо

Выбор функции для категории Текстовые сессии.
Возможные значения:

  • Инфо (info, 1) – Возвращает совокупную информацию по активным текстовым сессиям текущего домена в виде JSON-структуры.

Название: Метод
Код: method_system
Усл. видимости: нет
По умолчанию: Общая лицензия

Выбор функции для категории Система.
Возможные значения:

  • Общая лицензия (lic, 1) – Возвращает совокупную информацию по текущей действующей лицензии в виде JSON-структуры. Значение выдается только для сценариев мастер-домена.

  • Лицензии домена (domain_lic, 2) – Возвращает информацию по составу используемых лицензий в указанном домене из поддерева дочерних доменов в виде JSON-структуры.

Название: Поддомен
Код: subdomain
Усл. видимости: нет
По умолчанию: — 

Название домена в дереве дочерних доменов текущего домена.

Название: Охват
Код: scope
Усл. видимости: да
По умолчанию: Сайт

Выбор охвата для запроса.
Возможные значения:

  • Сайт (site, 0) – Ограничивает выдачу текущим сайтом.

  • Система (system, 1) – Возвращает данные по всей системе.

Название: Параметры
Код: params
Усл. видимости: нет
По умолчанию: — 

Аргумент, содержащий JSON-структуру в виде объекта с параметрами для выполняемого запроса.
Параметризуются следующие запросы:

  • Звонки, Диаграмма активности – JSON-объект содержит:

    • состав звонков (callid: "…​" или callids: ["…​", "…​", …​]),

    • формат выдачи (mode: "svg" | "plantuml"),

    • режим выдачи (file: true | false).

Название: Время, мс
Код: timeout
Усл. видимости: нет
По умолчанию: 1000

Таймаут ожидания выполнения операции, в миллисекундах.

Название: Результат в переменную
Код: resultVariable
Усл. видимости: нет
По умолчанию: — 

Переменная для сохранения результата выполнения операции.

Название: Переход
Код: transfer
Усл. видимости: нет
По умолчанию: — 

Компонент, которому передается управление при успешном выполнении операции.

Название: Переход, время
Код: transferTimeout
Усл. видимости: нет
По умолчанию: — 

Компонент, которому передается управление по истечении таймаута ожидания.

Название: Переход, ошибка
Код: transferError
Усл. видимости: нет
По умолчанию: — 

Компонент, которому передается управление в случае возникновения ошибки.

См. также