Участники (participants)

Запросы

HTTP verb Endpoint Описание

POST

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

Добавление участника

GET

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

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

GET

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

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

PATCH

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

Изменение данных участника

DELETE

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

Удаление участника

Добавление участника

Запрос

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

Пример запроса
POST /rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c/participants HTTP/1.1
Content-Type: application/json; charset=utf-8

selector’s participant entity

Ответ

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

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "61c0b3aa-016d-61e6-0f67-50e54938780c",
  "name": "",
  "number": "",
  "state": "waiting",
  "hold": false,
  "mic": true,
  "spk": true,
  "recall": false,
  "topology_type": "listener"
}

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

Запрос

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

filter

object

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

mask

str

Список полей для вывода. Доступные поля для выдачи: id, displayname, enabled, topology_mode, timestartutc, calldurationsec, state, default_spk, default_mic, default_recall.

offset

int

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

limit

int

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

order

array<object|str>

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

flat

bool

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

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

Пример запроса
GET /rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c/participants HTTP/1.1

Ответ

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

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id": "61c0b3aa-016d-61e6-0f67-50e54938780c",
    "name": "Vasya",
    "number": "123",
    "state": "waiting",
    "hold": false,
    "mic": true,
    "spk": true,
    "recall": false,
    "topology_type": "listener"
  },
  {
    "id": "eb3864c3-016d-5d75-9544-50e54938780c",
    "name": "16",
    "number": "16",
    "state": "waiting",
    "hold": false,
    "mic": true,
    "spk": true,
    "recall": false,
    "topology_type": "listener"
  }
]

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

Запрос

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

mask

str

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

flat

bool

Преобразование в плоский вид составных полей.
Пример запроса
GET /rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c/participants/61c0b3aa-016d-61e6-0f67-50e54938780c HTTP/1.1

Ответ

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

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "61c0b3aa-016d-61e6-0f67-50e54938780c",
  "name": "Vasya",
  "number": "123",
  "state": "waiting",
  "hold": false,
  "mic": true,
  "spk": true,
  "recall": false,
  "topology_type": "listener"
}

Изменение данных участника

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

Запрос

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

Пример запроса
PATCH /rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c/participants/61c0b3aa-016d-61e6-0f67-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8

selector’s participant entity

Ответ

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

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "61c0b3aa-016d-61e6-0f67-50e54938780c",
  "name": "Vasya",
  "number": "123",
  "state": "waiting",
  "hold": false,
  "mic": true,
  "spk": true,
  "recall": false,
  "topology_type": "listener"
}

Удаление участника

Запрос

Пример запроса
DELETE /rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c/participants/61c0b3aa-016d-61e6-0f67-50e54938780c HTTP/1.1

Ответ

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

Связанные композитные ресурсы

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