Participants (participants)

Requests

HTTP verb Endpoint Description

POST

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

Adding a participant

GET

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

Getting the list of participants

GET

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

Getting participant data

PATCH

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

Modifying participant data

DELETE

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

Deleting a participant


Adding a participant

Request

Field description: selector’s participant entity

Example request
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

Response

Field description: selector’s participant entity

Example response
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"
}

Getting the list of participants

Request

Table 1. Request parameters
Name Type Description

filter

object

Filter by field values.

mask

str

List of fields to output. Available fields for output: id, displayname, enabled, topology_mode, timestartutc, calldurationsec, state, default_spk, default_mic, default_recall.

offset

int

Offset in the list of resources to output.

limit

int

Maximum number of resources in the list.

order

array<object|str>

Sorting order of resources in the list.

flat

bool

Transformation of composite fields to flat form.

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

Response

Field description: selector’s participant entity

Example response
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"
  }
]

Getting participant data

Request

Table 2. Request parameters
Name Type Description

mask

str

List of fields to output.

flat

bool

Transformation of composite fields to flat form.

Example request
GET /rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c/participants/61c0b3aa-016d-61e6-0f67-50e54938780c HTTP/1.1

Response

Field description: selector’s participant entity

Example response
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"
}

Modifying participant data

Fields prohibited for modification: id

Request

Field description: selector’s participant entity

Example request
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

Response

Field description: selector’s participant entity

Example response
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"
}

Deleting a participant

Request

Example request
DELETE /rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c/participants/61c0b3aa-016d-61e6-0f67-50e54938780c HTTP/1.1

Response

Example response
HTTP/1.1 204 No Content