Participants (participants)

Table of Contents

Requests
Related Composite Resources

Requests

HTTP verb Endpoint Description

HTTP verb	Endpoint	Description
`POST`	`/rest/v1/uc/selectors/<id>/participants`	Adding a member
`GET`	`/rest/v1/uc/selectors/<id>/participants`	Obtaining the list of participants
`GET`	`/rest/v1/uc/selectors/<id>/participants/<id_abon>`	Obtaining participant data
`PATCH`	`/rest/v1/uc/selectors/<id>/participants/<id_abon>`	Changing participant data
`DELETE`	`/rest/v1/uc/selectors/<id>/participants/<id_abon>`	Deletion of a participant

POST

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

Adding a member

GET

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

Obtaining the list of participants

GET

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

Obtaining participant data

PATCH

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

Changing participant data

DELETE

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

Deletion of a participant

Adding a member

Request

Field Description: selector’s participant entity

Request example

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

Response example

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

Obtaining 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 be issued.
`limit`	`int`	The maximum number of resources in the list.
`order`	`array<object\|str>`	The sort order of the resources in the list.
`flat`	`bool`	Conversion to flat form of composite fields.

Details about the format of GET request parameters

Request example

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

Response

Field Description: selector’s participant entity

Response example

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

Obtaining participant data

Request

Table 2. Request parameters
Name	Type	Description
`mask`	`str`	A list of fields to output.
`flat`	`bool`	Conversion to flat form of composite fields.

Request example

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

Response example

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

Changing participant data

Fields prohibited for modification: id

Request

Field Description: selector’s participant entity

Request example

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

Response example

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

Deletion of a participant

Request

Request example

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

Response

Response example

HTTP/1.1 204 No Content

Related Composite Resources

Parent: selectors meetings