List all active Participants

{
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants?PageToken=PA1234",
  "first_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants",
  "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",
  "previous_page_uri": null,
  "page": 0,
  "page_size": 50,
  "participants": [
    {
      "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
      "call_sid": "b3877c40-da60-4998-90ad-b792e98472ca",
      "call_sid_to_coach": "b3877c40-da60-4998-90ad-b792e98472co",
      "coaching": false,
      "conference_sid": "b3877c40-da60-4998-90ad-b792e98472cf",
      "date_created": "Mon, 24 Sept 2018 21:00:00 +0000",
      "status": "completed",
      "date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
      "end_conference_on_exit": false,
      "muted": false,
      "hold": false,
      "start_conference_on_enter": true,
      "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"
    }
  ]
}

Lists the callers currently participating in a voice conference. Each participant is identified by the Call SID used for individual control. Video conference participants belong to Video Rooms and are not returned here.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

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

The request has succeeded.

uristring

The URI of the current page.

first_page_uristring

The URI of the first page.

next_page_uristring or null

The URI of the next page.

previous_page_uristring or null

The URI of the previous page.

pageinteger

The current page number.

page_sizeinteger

The number of items per page.

participantslist of objects

List of participants.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error