Participants

List room participants

Retrieve a collection of conference room participants.

GEThttp://127.0.0.1:8888/api/conference_rooms/{id}/participants

Path parameters

id*all of

The unique ID of conference room.

Response

2004XX

OK

Body

application/json

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/conference_rooms/{id}/participants', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": {},
      "display_name": "\"example\"<sip:[e-mail]>",
      "muted": false,
      "chairman": false,
      "position": 0
    }
  ]
}

Get room participant details

Get room participant details.

GEThttp://127.0.0.1:8888/api/conference_rooms/{id}/participants/{participant_id}

Path parameters

id*all of

The unique ID of conference room.

participant_id*all of

The unique ID of conference room participant.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of conference room participant.

display_namestring

The display name of conference room participant.

Example: "\"example\"<sip:[e-mail]>"

mutedboolean

Whether the participant is muted.

chairmanboolean

Indicates whether the user is chairman of the conference room.

positioninteger (int32)

The position of room member.
The member will not be displayed when -1 is specified.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/conference_rooms/{id}/participants/{participant_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": {},
  "display_name": "\"example\"<sip:[e-mail]>",
  "muted": false,
  "chairman": false,
  "position": 0
}