Операция

Операция

Мультифункциональный компонент, предоставляющий различные методы изменения настроек домена Oktell Studio:

  • CRUD в домене - управление записями объектов настройки Домена. Производит аналогичные действия, как и в Web-интерфейсе Администрирования.

  • Привязка звонка - возможность привязать к звонку дополнительные теги, которые будут сохраняться при переводах звонка (SIP Reffer)

  • Управление звонком - возможность управлять существующими звонками и инициировать новые

  • Управление sipuser - управлениe sipuser для выставления huntblock

CRUD в домене

Позволяет осуществлять CRUD операции над всеми объектами настроек любого домена Oktell Studio. CRUD операции

  • Create - создание новой записи в объекте

  • Read - чтение записей из объекта

  • Update - обновление записи в объекте

  • Delete - удаление записи в объекте

Свойства настройки компонента Операция для Тип = CRUD в домене:

operationCRUD
Рис. 1. Операция 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 в домене:

operationBinding
Рис. 2. Операции привязки звонка
Название Описание

Тип операции

Привязка звонка – Управление метки у звонков

Метод

Выбор операции.

  • Добавить – Добавляет метку.

  • Удалить – Удаляет метку.

  • Изменить – Заменяет метку на новую.

  • Очистить – Очищает метку.

  • Проверить – Проверяет наличие указанной метки и возвращает 1 или 0.

  • Получить – Возвращает метки

Идентификатор звонка

Аргумент, содержащий идентификатор звонка: CallId или DialogId.

Метка

Аргумент, содержащий текстовое содержание метки.

Результат в переменную

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

Переход

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

Переход, время

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

Переход, ошибка

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

Описание

Описание компонента
Работать можно только со звонками, одна из сторон которого является абонентом текущего домена (внутренний абонент, внешняя линия, IVR-сценарий, Конференция/Селектор).

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

Используется для управления звонками.

Свойства настройки компонента Операция для Тип = Управление звонком:

operationCall
Рис. 3. Операции Управления звонком
Название Описание

Тип операции

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

Метод

Выбор метода управления звонком. Более подробно описано ниже в Методы управления звонками

Параметры

JSON структура параметров в зависимости от выбранного метода. Подробно описано в документе "API управления звонками и конференциями" (доступно при запросе в Технической поддержке)

Метка

Аргумент, содержащий текстовое содержание метки.

Результат в переменную

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

Переход

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

Переход, время

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

Переход, ошибка

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

Описание

Описание компонента

Методы управления звонками

Метод Описание

Поиск звонка

Возвращает идентификатор звонка (DialogId) по одному из ключевых значений: DialogId, InviteId, CallId одного из плеч, URI одного из плеч в формате <sip:Username@Domain> и др.

Поиск конференции

Возвращает идентификатор конференции (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.

Остановка конференции

Осуществляет завершение указанной конференции с автоматическим отключением всех участников.

Список участников

Возвращает список участников конференции.

Информация об участнике

Возвращает информацию об участнике конференции.

Присоединение участника

Осуществляет исходящий вызов из указанной конференц на указанный номер.

Исключение участника

Осуществляет отключение участника из конференции.

Управление sipuser

Операция управления sipuser для выставления huntblock.

Свойства настройки компонента Операция для Тип = Управление sipuser:

manageSipuser
Рис. 4. Операции управление sipuser
Название Описание

Тип операции

Управление sipuser

Метод

Выбор метода операции. Возможные значения:

  • Установка huntblock (huntblock)

  • Выборочный huntblock (huntblockpart)

Логин или Id

Аргумент, содержащий логин или id сущности sipuser в домене.

Тип таймаута

Выбор типа таймаута. Возможные значения:

  • Заменить (single_newexpire, 1) – Замена одиночного состояния на другое такое же с установкой нового таймера автоудаления.

  • Максимальный (single_maxexpire, 2) – Замена одиночного состояние на другое такое же с установкой таймера автоудаления на время равное max(остаток, новое время).

Таймаут, сек.

Время блокировки указанного sipuser для очередей huntq в секундах.

Ханты

Список кодов или идентификаторов объектов hunt (через запятую), к которым применяется выборочная блокировка указанного sipuser для очередей huntq.

Комментарий

Комментарий блокировки указанного sipuser для очередей huntq.

Результат в переменную

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

Переход

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

Переход, время

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

Переход, ошибка

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

Описание

Описание компонента