Селекторные совещания (selectors)

Содержание

Запросы
Содержание (дочерние композитные ресурсы)
См. также

Запросы

HTTP verb Endpoint Описание

HTTP verb	Endpoint	Описание
`POST`	`/rest/v1/uc/selectors`	Создание нового селектора
`GET`	`/rest/v1/uc/selectors`	Получение списка селекторов
`GET`	`/rest/v1/uc/selectors/<id>`	Получение данных селектора
`PATCH`	`/rest/v1/uc/selectors/<id>`	Изменение данных селектора
`DELETE`	`/rest/v1/uc/selectors/<id>`	Удаление селектора

POST

/rest/v1/uc/selectors

Создание нового селектора

GET

/rest/v1/uc/selectors

Получение списка селекторов

GET

/rest/v1/uc/selectors/<id>

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

PATCH

/rest/v1/uc/selectors/<id>

Изменение данных селектора

DELETE

/rest/v1/uc/selectors/<id>

Удаление селектора

Создание нового селектора

Запрос

Описание полей: selector entity

Пример запроса

POST /rest/v1/uc/selectors HTTP/1.1
Content-Type: application/json; charset=utf-8

selector entity

Ответ

Описание полей: selector entity

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "2c51f8a2-016d-5d72-d44a-50e54938780c",
  "state": "waiting"
}

Получение списка селекторов

Запрос

Table 1. Параметры запроса
Имя	Тип	Описание
`filter`	`object`	Фильтр по значениям полей.
`mask`	`str`	Список полей для вывода. Доступные поля для выдачи: id, name, login, phonenumber, reg, iduser, opts.modextin, opts.modextout, opts.trunks, ext.lwt, ext.ct.
`offset`	`int`	Смещение в списке ресурсов, подлежащих выдаче.
`limit`	`int`	Максимальное количество ресурсов в списке.
`order`	`array<object\|str>`	Порядок сортировки ресурсов в списке.
`flat`	`bool`	Преобразование в плоский вид составных полей.

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

Пример запроса

GET /rest/v1/uc/selectors?offset=0&limit=2 HTTP/1.1

Ответ

Описание полей: selector entity

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id": "2c51f8a2-016d-5d72-d44a-50e54938780c",
    "state": "waiting",
    "calldurationsec": 0,
    "calltimeout": 20,
    "displayname": "SelectorAAA",
    "enabled": false,
    "timestartutc": "2019-09-23 14:30",
    "topology_mode": "topology",
    "comment": "",
    "default_mic": true,
    "default_recall": true,
    "default_spk": true
  },
  {
    "id": "d713088d-016d-5d72-ae04-50e54938780c",
    "state": "waiting",
    "calldurationsec": 300,
    "calldurationsec": 20,
    "displayname": "SelectorBBB",
    "enabled": false,
    "timestartutc": "2019-09-23 09:30",
    "topology_mode": "abonent",
    "comment": "test",
    "default_mic": true,
    "default_recall": true,
    "default_spk": true
  }
]

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

Запрос

Table 2. Параметры запроса
Имя	Тип	Описание
`mask`	`str`	Список полей для вывода.
`flat`	`bool`	Преобразование в плоский вид составных полей.

Пример запроса

GET /rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c HTTP/1.1

Ответ

Описание полей: selector entity

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "2c51f8a2-016d-5d72-d44a-50e54938780c",
  "state": "waiting",
  "calldurationsec": 0,
  "calltimeout": 20,
  "displayname": "SelectorAAA",
  "enabled": false,
  "timestartutc": "2019-09-23 14:30",
  "topology_mode": "topology",
  "comment": "",
  "default_mic": true,
  "default_recall": true,
  "default_spk": true
}

Изменение данных селектора

Поля запрещенные для изменения: id

Запрос

Описание полей: selector entity

Пример запроса

PATCH /rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8

selector entity

Ответ

Описание полей: selector entity

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "2c51f8a2-016d-5d72-d44a-50e54938780c",
  "state": "waiting",
  "calldurationsec": 300,
  "calltimeout": 20,
  "displayname": "Hello World",
  "enabled": true,
  "timestartutc": "2019-09-23 14:30",
  "topology_mode": "abonent",
  "comment": "test",
  "default_mic": true,
  "default_recall": true,
  "default_spk": true
}

Удаление селектора

Запрос

Пример запроса

DELETE /rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c HTTP/1.1

Ответ

Пример ответа

HTTP/1.1 204 No Content

Содержание (дочерние композитные ресурсы)

Дочерний: Абоненты
Дочерний: Голосования
Дочерний: Топология

См. также

API /rest/v1/fs/targets/selector – управление файлами звукозаписей для предварительного воспроизведения в селекторах.