Управление выполнением IVR сценариев (ivrscript_runtimes)

Обзор

Управляет активными обработчиками IVR сценариев.
Обработчик IVR сценария – это алгоритм, интерпретирующий экземпляр IVR-сценария.

Запросы

HTTP verb Endpoint Описание

GET

/rest/v1/uc/ivrscript_runtimes

Получение списка выполняющихся экземпляров IVR сценариев

DELETE

/rest/v1/uc/ivrscript_runtimes/<id>

Остановка экземпляра IVR сценария

Получение списка выполняющихся экземпляров IVR сценариев

Возвращает список всех обработчиков IVR сценариев, исполняемых системой в текущем домене на всех доступных сайтах, где он обслуживается.

Запрос

Table 1. Параметры запроса
Имя Тип Описание

filter

object

Фильтр по значениям полей.

mask

str

Список полей для вывода.

offset

int

Смещение в списке ресурсов, подлежащих выдаче.

limit

int

Максимальное количество ресурсов в списке.

order

array<object|str>

Порядок сортировки ресурсов в списке.

flat

bool

Преобразование в плоский вид составных полей.

Подробно про формат параметров GET-запроса

Пример запроса
GET /rest/v1/uc/ivrscript_runtimes HTTP/1.1

Ответ

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

Table 2. Описание полей:
Поле Описание

id

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

site

Сайт, на котором выполняется обработчик.

node

Нода, в рамках которой выполняется обработчик.

domain

Домен сценария.

type

Тип сценария.

code

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

name

Название выполняемого сценария. Если исходный сценарий передал управление вложенному сценарию, то возвращается название вложенного сценария.

starttime

Дата и время запуска обработчика в формате RFC3339 в UTC.
Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id": "244f84aa-0624-e639-8061-a80000000006",
    "site": "SITE1",
    "node": "site1_h6@192.168.0.12",
    "domain": "test.rootdomain.ru",
    "type": "ivr",
    "code": "player",
    "name": "TEST PLAY",
    "starttime": "2019-11-05T08:36:40Z"
  },
  {
    "id": "6b3ba923-0624-e8c9-6bee-b00000000008",
    "site": "SITE1",
    "node": "site1_h8@192.168.0.12",
    "domain": "test.rootdomain.ru",
    "type": "ivr",
    "code": "welcome",
    "name": "Главный сценарий",
    "starttime": "2019-11-05T11:31:34Z"
  }
]

Остановка экземпляра IVR сценария

Принудительно завершает работу обработчика сценария.

Если в текущем выполняемом сценарии задана ветка пост-обработки, соответствующая типу завершения Внешняя остановка, то управление передается ей, и обработчик продолжает выполняться. В этом случае для полной остановки обработчика потребуется еще один API-запрос DELETE.

Запрос

Пример запроса
DELETE /rest/v1/uc/ivrscript_runtimes/244f84aa-0624-e639-8061-a80000000006 HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 204 No Content

См. также

  • Персонализация
  • Увеличить шрифт
  • Уменьшить шрифт