List conference participants

GET 
/conferences/:conference_id/participants

Lists conference participants

Request

Path Parameters

conference_id stringrequired

Uniquely identifies the conference by id

Query Parameters

filter[muted] boolean

If present, participants will be filtered to those who are/are not muted

filter[on_hold] boolean

If present, participants will be filtered to those who are/are not put on hold

filter[whispering] boolean

If present, participants will be filtered to those who are whispering or are not

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page

Responses

200: Successful response with a list of conference participants.

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

record_type stringrequired

Possible values: [participant]

id stringrequired

Uniquely identifies the participant

call_leg_id stringrequired

Uniquely identifies the call leg associated with the participant

call_control_id stringrequired

Call Control ID associated with the partiipant of the conference

conference

object

required

Info about the conference that the participant is in

id string

Uniquely identifies the conference

name string

Name of the conference

Info about the conference that the participant is in

whisper_call_control_ids string[]required

Array of unique call_control_ids the participant can whisper to..

created_at stringrequired

ISO 8601 formatted date of when the participant was created

updated_at stringrequired

ISO 8601 formatted date of when the participant was last updated

end_conference_on_exit booleanrequired

Whether the conference will end and all remaining participants be hung up after the participant leaves the conference.

soft_end_conference_on_exit booleanrequired

Whether the conference will end after the participant leaves the conference.

status stringrequired

Possible values: [joining, joined, left]

The status of the participant with respect to the lifecycle within the conference

muted booleanrequired

Whether the participant is muted.

on_hold booleanrequired

Whether the participant is put on_hold.

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "data": [
    {
      "record_type": "participant",
      "created_at": "2019-01-23T18:10:02.574Z",
      "updated_at": "2019-01-23T18:10:02.574Z",
      "end_conference_on_exit": true,
      "soft_end_conference_on_exit": true,
      "status": "joining",
      "muted": false,
      "on_hold": true,
      "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
      "whisper_call_control_ids": [
        "v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ",
        "v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw"
      ],
      "id": "dfadada7-af74-47bc-83a4-554275f55f5c",
      "call_leg_id": "3a15df2d-c801-4729-adf5-b56dd42e2abb",
      "conference": {
        "id": "41b9acd4-f4da-4ff5-a85c-e07e90b53f46",
        "name": "1"
      }
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

401: Unauthorized

404: Conference does not exist

422: Unprocessable entity

Loading...