REST ClientCompatConferences

list_participants

View as MarkdownOpen in Claude

List participants in a conference.

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account that created this conference.
ConferenceSidstringRequiredformat: "uuid"
The unique identifier for the conference this participant is in.

Query parameters

MutedbooleanOptional
Whether or not a participant is muted.
HoldbooleanOptional
Whether or not a participant is on hold.
PageintegerOptional>=0Defaults to 0
The page number to retrieve. Page numbers are zero-indexed, so the first page is 0.
PageSizeintegerOptional1-1000Defaults to 50
The number of results to return per page. The default is 50, and the maximum is 1000.
PageTokenstringOptional
A token used to retrieve a specific page of results. Must start with PA or PB.

Response

uristringRequired
The URI of the current page.
first_page_uristringRequired
The URI of the first page.
next_page_uristring or nullRequired
The URI of the next page.
previous_page_uristring or nullRequired
The URI of the previous page.
pageintegerRequired
The current page number.
page_sizeintegerRequired
The number of items per page.
participantslist of objectsRequired
List of participants.

Response Example

Response
1{
2  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants?PageToken=PA1234",
3  "first_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants",
4  "next_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants?Page=1&PageToken=PA5678",
5  "page": 0,
6  "page_size": 50,
7  "participants": [
8    {
9      "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
10      "call_sid": "b3877c40-da60-4998-90ad-b792e98472ca",
11      "call_sid_to_coach": "b3877c40-da60-4998-90ad-b792e98472co",
12      "coaching": false,
13      "conference_sid": "b3877c40-da60-4998-90ad-b792e98472cf",
14      "date_created": "Mon, 24 Sept 2018 21:00:00 +0000",
15      "status": "completed",
16      "date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
17      "end_conference_on_exit": false,
18      "muted": false,
19      "hold": false,
20      "start_conference_on_enter": true,
21      "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants/b3877c40-da60-4998-90ad-b792e98472ca.json"
22    }
23  ]
24}

Example

1from signalwire.rest import RestClient
2
3client = RestClient(
4    project="your-project-id",
5    token="your-api-token",
6    host="your-space.signalwire.com",
7)
8
9participants = client.compat.conferences.list_participants("CF...")