REST Client MethodsConference Participants

List

View as Markdown

Use this endpoint for the Conference Participants method to read all of the active participants that are associated with this conference call. This will be returned as a list of participants.

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
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  "previous_page_uri": "string",
6  "page": 0,
7  "page_size": 50,
8  "participants": [
9    {
10      "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
11      "call_sid": "b3877c40-da60-4998-90ad-b792e98472ca",
12      "call_sid_to_coach": "b3877c40-da60-4998-90ad-b792e98472co",
13      "coaching": false,
14      "conference_sid": "b3877c40-da60-4998-90ad-b792e98472cf",
15      "date_created": "Mon, 24 Sept 2018 21:00:00 +0000",
16      "status": "completed",
17      "date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
18      "end_conference_on_exit": false,
19      "muted": false,
20      "hold": false,
21      "start_conference_on_enter": true,
22      "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"
23    }
24  ]
25}

Request examples

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.conferences('ConferenceSid')
5      .participants
6      .each(participants => console.log(participants.callSid));