Help-Center
Search…
Блок Управление

Старт

Компонент начала действий. Обязателен один и только один компонент, в котором Тип старта = Начало.
Можно создать несколько компонентов Старт с разными типами

Старт. Тип Начало

Это первоначальная точка запуска сценария. Должен быть создан один и только доин такой компонент. При создании нескольких поведение сценария может быть непредсказуемым.
Название
Описание
Тип старта
Рассматривается когда равно Начало
Параметр запуска
Определяется переменная, в которую сохранится первый стартовый параметр
Инициализировать переменные
Если выбрать ДА, то все локальные переменные получат стартовые значения (числа - 0, строки - "", даты - 01.01.2000 00:00:00, остальное - "undefined"). Если Нет, то первоначальные значения не будут инициализированы (получат стартовое значение - "undefined"). По-умолчанию = Да
Переход
На какой компонент будет переход действия
Описание
Описание компонента

Старт. Тип Постобработка

Это точка начала постобработки при завершении основной ветки сценария по одному из преднастроенных вариантов.
Название
Описание
Тип старта
Рассматривается когда равно Постобработка
Вариант перехода
Причина завершения основной ветки выполнения сценария, по возникновению которой в рамках пост-обработки будет выполнена цепочка компонентов, следующих за текущим компонентом СТАРТ. Возможные значения:
  • Все – любая причина завершения сценария.
  • Корректное завершение – сценарий завершен корректно компонентами, не имеющими веток перехода (Стоп, Переводы и т.д.).
  • Нет ветки перехода – не назначено необходимое свойство перехода у компонента основной ветки сценария.
  • Внешняя остановка – сценарий принудительно завершен (через API или монитор запрос).
  • Ошибка компонента – критическая ошибка выполнения компонента.
  • Падение владельца – завершение связанного процесса владельца, например FSM диалога звонка для IVR сценария.
  • Лимит числа компонентов – достижение ограничения по количеству выполненных компонентов, установленного для домена.
  • Лимит времени выполнения – достижение ограничения по времени выполнения сценария, установленного для домена.
Время выполнения
Ограничение на выполнение сценария в рамках ветки пост-обработки, в миллисекундах. По истечении сценарий принудительно завершится. По-умолчанию 60 сек.
Переход
На какой компонент будет переход действия
Описание
Описание компонента

Стоп

Завершает выполнение сценария.
Может быть несколько в рамках сценария. Достижение любого вызывает корректную остановку выполнения текущего экземпляра сценария.
Стоп
Название
Описание
Возврат управления
  • Да - будет возвращено управление в сценарий, который вызвал текущий.
  • Нет - цепочка выполнения сценариев будет завершена. Возврат в родительский сценарий не будет
Описание
Описание компонента

Пауза

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

Сравнение

Сравнивает значения двух аргументов. Компонент осуществляет ветвление внутри сценария. Над двумя аргументами выполняется выбранная логическая операция (Аргумент 1 - Логическая операция - Аргумент 2). Если результат выполнения true, то переход по ветке Правда, в противном случае – по ветке Ложь.
Сравнение
Название
Описание
Аргумент 1
Левое сравниваемое значение в выражении
Аргумент 2
Правое сравниваемое значение в выражении
Тип сравнения
  • < меньше
  • <= меньше или равно
  • == равно
  • => больше или равно
  • > больше
  • =/= не равно
Переход, правда
На какой компонент будет переход действия, если результат сравнения вернул True
Переход, ложь
На какой компонент будет переход действия, если результат сравнения вернул False
Описание
Описание компонента

Меню сравнения

Сравнивает аргумент со списком значений. Компонент осуществляет ветвление внутри сценария в зависимости от фактического значения аргумента. Может иметь большое число веток перехода (до 127). Переход осуществляется по ветке значения, равного значению выбранного аргумента. Если совпадений не найдено, переход осуществляется по ветке Прочее.
Меню сравнения
Название
Описание
Аргумент
Аргумент значения левой части равенства
Значения
Отдельное окно ввода значений правой части равенства и переходов в случае если равенство корректное. Открывается Меню множественных переходов по клике на троеточие (отмечено красным в figure_title)
Переход, прочее
Компонент, на который передается управление, если среди значений не найдено того, которое соответствует значению аргумента.
Описание
Текст

Меню множественных переходов

Позволяет ввести значения правой части сравнения и указать Переходы в случае если равенство корректное.
Управление переходами Меню сравнения
Если значение равно
То переход к компоненту
Указывается константа равенства
Выбирается компонент, на который будет переход в случае равенства
Если указать два одинаковых значения, то переход будет осуществлен по первому из них в списке

Присвоение

Задает значение указанной переменной. В качестве присваиваемого значения выступает аргумент. Используется автоматический механизм преобразования типов, если типы значения аргумента и переменной не совпадают. Возможно присвоение как для одной переменной, так и для нескольких.
Два основных режима работы компонента
  • одиночное присвоение (одной переменной присваивается одно значение)
  • множественное присвоение (множеству переменным присваиваются значения)

Одиночное присвоение

Свойства компонента:
Одиночное присвоение
Название
Описание
Режим
рассматривается одиночный режим
Переменная
Локальная переменная, в которую нужно записать указанное значение.
Значение
Аргумент который будет записан в переменную после вычисления.
Переход
Компонент, которому передается управление после завершения текущего.
Описание
Дополнительное описание компонента, если необходимо

Множественное присвоение

Свойства компонента:
Множественное присвоение
Название
Описание
Режим
рассматривается множественный режим
Операция
Список последовательно выполняющихся операций присвоения, где каждой переменной сопоставляется отдельный аргумент. Окно множественного присвоения открывается по клику на троеточие справа (отмечено красным на figure_title )
Переход
Компонент, которому передается управление после завершения текущего.
Описание
Дополнительное описание компонента, если необходимо
Управление множественным присвоением
В окне множественного присвоения слева выбирается Переменная, а справа вводится Аргумент. Строки можно перетаскивать вверх/вниз.
Присвоение выполняется последовательно сверху вниз и иногда порядок выполнения важен для корректной работы сценария.

Запуск сценария

Позволяет вызывать другие сценария - передавать управление на компонент Старт указанного сценария. Два основных режима работы:
  • Вложенный. Будет запущен вложенный сценарий, в него будут переданы все переменные текущего сценария и будет ожидание завершения вложенного сценария для продолжения работы текущего. Для продолжения работы текущего сценария у вложенного должен сработать компонент Стоп с установленным признаком Возврат управления. Вс переменные из вложенного сценария будут возвращены в текущий с новыми значениями.
  • Асинхронный. Будет запущен новый сценарий, в него будут скопированы все текущие переменные и их значения. Текущий сценарий продолжит работы не дожидаясь завершения асинхронного. Переменные текущего сценария не зависят от изменений значений в асинхронном сценарии. В качестве Асинхронного можно запустить только Служебный сценарий.
Название
Описание
Режим
  • Вложенный - Запускается в том же обработчике, приостанавливая выполнение текущего сценария и передавая вложенному сценарию весь набор переменных и их значений. После завершения вложенного сценария может быть осуществлен возврат управления на следующий компонент ветки Переход Допускается каскадная вложенность сценариев глубиной до 100 уровней.
  • Асинхронный служебный - Запускается новый экземпляр обработчика служебного сценария. Исполнение производится на произвольной Роли SCR текущего сайта. Запущенный сценарий получает весь набор переменных и их значений на вход.
Источник сценария
  • Из списка - выбор вложенного сценария из списка Сценарии.
  • Код сценария - указание кода сценария с помощью аргумента в Код сценария.
ИД в переменную
Переменная для сохранения значения идентификатора запущенного сценария, по которому можно производить Взаимодействие сценариев.
Параметр 1 ~ Параметр 5
(только для асинхронного режима). Передача до 5 дополнительных параметров. Доступ к значению осуществляется через функцию выражений startparam1() - startparam5() или через сохранение значения в компоненте Старт (для Параметр 1).
Возврат управления
(только для синхронного режима). Разрешает или запрещает возврат управления из вложенного сценария и продолжение работы по ветке дальше.
  • Да - вложенный сценарий вызывается как функция и после его завершения происходит возврат в точку вызова (с учетом значения свойства Возврат управления у компонента Стоп).
  • Нет - выполнение текущего сценария прекращается и запускается вложенный сценарий
Переход
Компонент, которому передается управление при успешном запуске асинхронного служебного сценария, либо после возврата управления из вложенного сценария. Переход по-умолчанию
Переход, ошибка
Компонент, которому передается управление при неудачном запуске сценария. Среди причин могут быть:
  • отсутствие сценария по коду
  • отсутствие доступа к доменному центру
  • отсутствие роли scr
  • превышение допустимых лимитов
  • другое
Описание
Описание компонента

Исходящий звонок

Осуществляет вызов указанного номера и при коммутации передает управление указанному сценарию IVR.
Возможны четыре режима работы:
  • Асинхронный. Запускается исходящий звонок и текущий сценарий продолжает свою работу без ожидания завершения инициированного звонка
  • Дождаться предварительного ответа (1XX). Текущий сценарий ожидает получения SIP ответа 1XX в инициированном звонке
  • Дождаться окончательного ответа (2XX-6XX). Текущий сценарий ожидает получения SIP ответа с кодами 2ХХ (удачного завершения попытки вызова) или 4ХХ-6ХХ (неудачного завершения попытки вызова).
  • Дождаться остановки IVR. Текущий сценарий ожидает завершения сценария, управляющего исходящим звонком (синхронный режим работы).
Обработка исходящего звонка осуществляет другой IVR сценарий. На его вход подаются данные о Номере назначения, Номере источника, Имени источника и дополнительный необходимый параметр (формат json в поле Входящий параметр компонента Старт дочернего IVR сценария).
Название
Описание
Режим
Свойства вариантов выбора описано выше
  • Асинхронный
  • Дождаться предварительного ответа (1ХХ)
  • Дождаться окончательного ответа (2ХХ-6ХХ)
  • Дождаться остановки IVR
Номер
Аргумент номера назначения, куда отправить вызов
Исходящий номер
Аргумент номера инициатора (Номер А), подставляемый в качестве username в заголовок From отправляемого SIP-запроса INVITE. Обязателен к указанию. Применяется в процессе маршрутизации звонка.
Исходящее имя
Аргумент имени (DisplayName) источника звонка Если значение не указано, то URI не содержит DisplayName.
Источник сценария
Выбор правила указания сценария IVR, который будет выступать виртуальным сотрудником от Номера А
  • Сценарий IVR - выбор сценария из выпадающего списка.
  • Код сценария IVR - необходимо запустить сценарий по указанному коду. Появляется поле Код сценария - аргумент, в который необходимо передать Код IVR сценария, который будет запущен
Значения переменных
Аргумент, содержащий JSON-структуру со списком начальных значений для локальных переменных сценария (упакованный в строку JSON-объект). Ключи и значения объекта соответствуют именам переменных и их начальным значениям. Таким образом, сопоставление происходит по именам переменных, значения присваиваются только тем переменным, которые определены в запускаемом сценарии. Установленные таким образом значения приоритетный перед значениями по умолчанию внутри сценария IVR (Поле инициализация компонента Старт.
Время, с
(для всех режимов, кроме Асинхронный) Максимальное время выполнения сценария звонка до срабатывания Переход - нет ответа.
SIP-код ответа в переменную
(для всех режимов, кроме Асинхронный) Переменная для сохранения последнего полученного кода SIP-ответа (1xx-6xx).
Переход
Следующий Компонент сценария. Переход по-умолчанию.
Переход, неудача
Компонент, которому передается управление в случае получения неудачного окончательного SIP-ответа (4xx-6xx). При незаполнении переход осуществляется по стандартной ветке.
Переход, нет ответа
Компонент, которому передается управление в случае истечения времени ожидания получения окончательного SIP-ответа в режимах ожидания окончательного и завершения сценария, либо предварительного ответа в режиме ожидания предварительного ответа. При незаполнении переход осуществляется по стандартной ветке.
Переход, ошибка
Компонент, которому передается управление в случае возникновения любой ошибки в процессе инициации звонка. При незаполнении переход осуществляется по стандартной ветке.
Описание
Описание компонента

Монитор

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

Категории запроса и методы

В зависимости от выбранных значений полей Категория и Метод определяется данные, которые будут возвращены компонентов. Вначале выбирается Категория, после выбирается один из связанных методов.
Категория
Описание категории
Метод
Описание метода
Учетные записи
Информация по учетным записям и их состояниям
Провайдеры SIP
Возвращает совокупную информацию по состояниям учетных записей SIP-провайдеров текущего домена в виде JSON-структуры.
SIP-телефоны
Возвращает совокупную информацию по состояниям учетных записей SIP-пользователей текущего домена в виде JSON-структуры.
Пользователи
Возвращает совокупную информацию по состояниям учетных записей пользователей текущего домена в виде JSON-структуры.
Звонки
Информация по активным звонкам текущего домена
Инфо
Возвращает совокупную информацию по активным звонкам в виде JSON-структуры.
Диаграмма активности
Возвращает диаграмму по звонку/смежным звонкам. Звонки указываются перечислением CallId. Возвращается значение всей цепочки коммутаций, где указанный звонок участвовал. В зависимости от выбранного режима возвращает содержание или путь к файлу, формат svg или plantuml.
Ханты
Информация по хант-группам и состояниям входящих в них агентам.
SIP
Возвращает совокупную информацию по хант-группам типа sip текущего домена и состояниям их агентов в виде JSON-структуры.
Очереди
Информация по очередям и составу ожидающих в них объектам/заданиям.
SIP
Возвращает совокупную информацию по очередям типа sip текущего домена и состояниям ожидающих в них объектам в виде JSON-структуры.
Сценарии
Информация по исполняющимся сценариям
Инфо
Возвращает совокупную информацию по активным выполняющимся сценариям текущего домена в виде JSON-структуры.
Селекторы
Информация по активным селекторным совещаниям и их участникам.
Инфо
Возвращает совокупную информацию по активным селекторным совещаниям текущего домена в виде JSON-структуры.
Система
Информация по системе
Общая лицензия
Возвращает совокупную информацию по текущей действующей лицензии в виде JSON-структуры. Значение выдается только для сценариев мастер-домена.
Лицензии домена
Возвращает информацию по составу используемых лицензий в указанном домене из поддерева дочерних доменов в виде JSON-структуры.

Управление компонентом

Свойства настройки компонента Монитор:
Монитор
Название
Описание
Категория запроса
Выбор Категорий и методов подробно описан выше в Категории запроса и методы
Метод
Охват
Выбор охвата для запроса.
  • Сайт – Ограничивает выдачу текущим сайтом.
  • Система – Возвращает данные по всей системе.
Параметры
Используется только для Категория = Звонки И Метод = Диаграмма активности Аргумент, содержащий JSON-структуру описывающую
{ "callid":"...", //CallID звонка, по цепочке которого собрать логи "mode":"svg|plantuml", //формат выдачи "file":"true|false" //формат выдачи (файл или ссылка на файл) }
Время, мс
Таймаут ожидания выполнения операции, в миллисекундах.
Результат в переменную
Переменная для сохранения результата выполнения операции.
Переход
Компонент, которому передается управление при успешном выполнении операции. Переход по-умолчанию
Переход, время
Компонент, которому передается управление по истечении таймаута ожидания.
Переход, ошибка
Компонент, которому передается управление в случае возникновения ошибки.
Описание
Описание компонента

Операция

Мультифункциональный компонент, предоставляющий различные методы изменения настроек домена Аксател:
• CRUD в домене - управление записями объектов настройки Домена. Производит аналогичные действия, как и в Web-интерфейсе Администрирования.
• Привязка звонка - возможность привязать к звонку дополнительные теги, которые будут сохраняться при переводах звонка (SIP Reffer)
• Управление звонком - возможность управлять существующими звонками и инициировать новые

CRUD в домене

Позволяет осуществлять CRUD операции над всеми объектами настроек любого домена Аксател. CRUD операции
  • Create - создание новой записи в объекте
  • Read - чтение записей из объекта
  • Update - обновление записи в объекте
  • Delete - удаление записи в объекте
Свойства настройки компонента Операция для Тип = CRUD в домене:
Название
Описание
Тип операции
CRUD в домене
Домен
Выбор домена, в котором проводится операция.
  • Сценария – Домен текущего сценария.
  • Другой – При выборе этого значения нужно указать название домена.
Логин пользователя
Аргумент, содержащий логин пользователя в домене. У пользователя с этим Логином должна быть включена опция "CRUD операция". Если Выбор домена = Другой, то в обоих доменах должны быть идентичные настройки для логин, пароль, включена опция CRUD операция
Тип сущности
Аргумент, содержащий имя объекта. Список всех объектов можно посмотреть через API или в Web интерфейсе Администрирования в URL необходимых разделов.
Метод
Выбор операции.
  • Создать – Создание сущности.
  • Получить – Получение набора сущностей.
  • Обновить – Изменение сущности.
  • Удалить – Удаление сущности.
Данные
(для Операция = Создать, Обновить, Удалить). Содержит JSON структуру для выбранной Сущности и Операции (например для Удалить должен содержать только
{"id":"id_element"}
Фильтр
(для Операция = Получить). Поисковый запрос для получения данных в JSON структуре в виде
{"id":"some_id","name":"some_name"}
Сортировка
(для Операция = Получить). Сортировка результата по указанным полям. Задается в JSON структуре в виде массива
[{"priority":"desc"},{"name":"asc"}] или ["priority","name"]
Поля
(для Операция = Получить). Указывается какие поля выбранной сущности необходимо получить. Задается в виде списка, например
id,name,ext.title
Доп.параметры
Определяет дополнительные режимы выполнения запроса в JSON структуре
  • offset - (только для Получить) Определяет сдвиг от нулевой записи в отфильтрованном и отсортированном списке.
  • limit - (только для Получить) Максимальное количество выдаваемых записей в отфильтрованном, отсортированном и смещенном списке
  • countonly - (только для Получить) Вернет вместо списка записей их количество
  • flat - (для всех Операций) Позволяет работать с одноуровневым JSON во всех полях
Результат в переменную
Переменная для сохранения результата операции. JSON структура результата выполнения Операции
Переход
Компонент, которому передается управление при успешном завершении операции.
Переход, время
Компонент, которому передается управление по истечении таймауте ожидания результата операции.
Переход, ошибка
Компонент, которому передается управление в случае возникновения ошибки.
Описание
Описание компонента
Получить полный список полей можно через режим Debug в браузере при работе с Web интерфейсом Администрирование или запросить в службе Технической поддержки документ по работе с API интерфейсом

Привязка звонка

Используется для дополнительного тегирования звонка. При переводе звонков теги сохраняются. Используется, например, для сбора контекста в рамках цепочки разговоров или для отслеживания с каким сотрудником сейчас общается клиент (для перевода карточки клиента между сотрудниками).
Свойства настройки компонента Операция для Тип = CRUD в домене:
Операции привязки звонка
Название
Описание
Тип операции
Привязка звонка – Управление метки у звонков
Метод
Выбор операции.
  • Добавить – Добавляет метку.
  • Удалить – Удаляет метку.
  • Изменить – Заменяет метку на новую.
  • Очистить – Очищает метку.
  • Проверить – Проверяет наличие указанной метки и возвращает 1 или 0.
  • Получить – Возвращает метки
Идентификатор звонка
Аргумент, содержащий идентификатор звонка: CallId или DialogId.
Метка
Аргумент, содержащий текстовое содержание метки.
Результат в переменную
Переменная для сохранения результата операции.
Переход
Компонент, которому передается управление при успешном завершении операции.
Переход, время
Компонент, которому передается управление по истечении таймауте ожидания результата операции.
Переход, ошибка
Компонент, которому передается управление в случае возникновения ошибки.
Описание
Описание компонента
Работать можно только со звонками, одна из сторон которого является абонентом текущего домена (внутренний абонент, внешняя линия, IVR-сценарий, Конференция/Селектор).

Управление звонком

Используется для управления звонками.
Свойства настройки компонента Операция для Тип = Управление звонком:
Название
Описание
Тип операции
Управление звонком
Метод
Выбор метода управления звонком. Более подробно описано ниже в Методы управления звонками
Параметры
JSON структура параметров в зависимости от выбранного метода. Подробно описано в документе "API управления звонками и конференциями" (доступно при запросе в Технической поддержке)
Метка
Аргумент, содержащий текстовое содержание метки.
Результат в переменную
Переменная для сохранения результата операции.
Переход
Компонент, которому передается управление при успешном завершении операции.
Переход, время
Компонент, которому передается управление по истечении таймауте ожидания результата операции.
Переход, ошибка
Компонент, которому передается управление в случае возникновения ошибки.
Описание
Описание компонента
Методы управления звонками
Метод
Описание
Поиск звонка
Возвращает идентификатор звонка (DialogId) по одному из ключевых значений: DialogId, InviteId, CallId одного из плеч, URI одного из плеч в формате <sip:[email protected]> и др.
Поиск конференции
Возвращает идентификатор конференции (ConfId) по одному из ключевых значений: ConfId, номер комнаты, URI конференции.
Список звонков
Возвращает список звонков в домене.
Список конференций
Возвращает список идентификаторов конференций (ConfId) в домене.
Информация о звонке
Возвращает информацию о звонке.
Информация о конференции
Возвращает информацию о конференции.
Исходящий вызов
Инициирует новый вызов от одного абонента к другому. Совершается сервисом IVR, который вызывает сначала одного абонента, а потом переключает его на другого с помощью SIP-запроса REFER.
Завершение звонка
Завершает указанный вызов или совокупность вызовов по указанному URI.
Перевод на номер
Осуществляет перевод абонента указанного звонка на указанный номер. Совершается сервисом IVR, который подменяет плечо (SIP-запрос INVITE+Replaces) и отправляет SIP-запрос REFER.
Соединение
Осуществляет соединение абонентов двух разных звонков, отбивая оставшихся. Совершается сервисом IVR, который подменяет плечо (SIP-запрос INVITE+Replaces), после этого переводит на другого абонента с помощью SIP-запроса REFER+Replaces.
Перевод на конференцию
Осуществляет переключение одного из абонентов указанного звонка на указанную конференцию. Если второй абонент держит конференцию на удержании, то ему остается нажать HOLD.
Преобразование в конференцию
Осуществляет перевод обоих абонентов звонка в общую конференцию. Совершается сервисами IVR, каждый из которых подменяет отдельное плечо с помощью SIP-запроса INVITE+Replaces, и затем переводит на номер конференц-комнаты с помощью SIP-запроса REFER.
Остановка конференции
Осуществляет завершение указанной конференции с автоматическим отключением всех участников.
Список участников
Возвращает список участников конференции.
Информация об участнике
Возвращает информацию об участнике конференции.
Присоединение участника
Осуществляет исходящий вызов из указанной конференц на указанный номер.
Исключение участника
Осуществляет отключение участника из конференции.