List all active Participants
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.
Path parameters
Universal Unique Identifier.
The unique identifier for the account that created this conference.
Universal Unique Identifier.
The unique identifier for the conference this participant is in.
Query parameters
Whether or not a participant is muted.
Whether or not a participant is on hold.
The page number to retrieve. Page numbers are zero-indexed, so the first page is 0.
The number of results to return per page. The default is 50, and the maximum is 1000.
A token used to retrieve a specific page of results. Must start with PA or PB.
Response
The request has succeeded.
Example response
{
"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",
"page_size": 50,
"participants": [
{
"date_created": "Mon, 24 Sept 2018 21:00:00 +0000",
"date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
"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"
}
]
}Changes
Changed in 6 of the 40 revisions of this API.15250
- ▲
the
participants/items/account_sidresponse's property type/format changed fromstring/uuidto/for status200response-property-type-changed
- ▲
the
participants/items/call_sidresponse's property type/format changed fromstring/uuidto/for status200response-property-type-changed
- ▲
the
participants/items/call_sid_to_coachresponse's property type/format changed from/uuidto/for status200response-property-type-changed
- ▲
the
participants/items/conference_sidresponse's property type/format changed fromstring/uuidto/for status200response-property-type-changed
- ○
added
uuidto theparticipants/items/account_sidresponse propertyallOflist for the response status200response-property-all-of-added
- ○
added
uuidto theparticipants/items/call_sidresponse propertyallOflist for the response status200response-property-all-of-added
- ○
added
uuidto theparticipants/items/conference_sidresponse propertyallOflist for the response status200response-property-all-of-added
- ○
added
uuidto theparticipants/items/call_sid_to_coachresponse propertyanyOflist for the response status200response-property-any-of-added
- ○
removed
subschema #1from theparticipants/items/call_sid_to_coachresponse propertyanyOflist for the response status200response-property-any-of-removed
- ▲
- ○
added 'unevaluatedProperties' constraint to the response body for the status
200response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the response body for the status
400response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the response body for the status
401response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the response body for the status
404response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the response body for the status
422response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the
participants/items/response property for the status200response-property-unevaluated-properties-added
- ○
- ▲
response property
next_page_urilist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
participants/items/call_sid_to_coachlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
previous_page_urilist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
- ▲
the response property
next_page_uribecame nullable for the status200response-property-became-nullable
- ▲
the response property
participants/items/call_sid_to_coachbecame nullable for the status200response-property-became-nullable
- ▲
the response property
previous_page_uribecame nullable for the status200response-property-became-nullable
- ●
removed the optional property
account_sidfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
conference_sidfrom the response with the200statusresponse-optional-property-removed
- ○
added the new optional
queryrequest parameterPagenew-optional-request-parameter
- ○
added the new optional
queryrequest parameterPageSizenew-optional-request-parameter
- ○
added the new optional
queryrequest parameterPageTokennew-optional-request-parameter
- ○
added the non-success response with the status
400response-non-success-status-added
- ○
added the non-success response with the status
404response-non-success-status-added
- ○
added the non-success response with the status
422response-non-success-status-added
- ○
the response property
first_page_uribecame required for the status200response-property-became-required
- ○
the response property
next_page_uribecame required for the status200response-property-became-required
- ○
the response property
pagebecame required for the status200response-property-became-required
- ○
the response property
page_sizebecame required for the status200response-property-became-required
- ○
the response property
participantsbecame required for the status200response-property-became-required
- ○
the response property
participants/items/account_sidbecame required for the status200response-property-became-required
- ○
the response property
participants/items/call_sidbecame required for the status200response-property-became-required
- ○
the response property
participants/items/call_sid_to_coachbecame required for the status200response-property-became-required
- ○
the response property
participants/items/coachingbecame required for the status200response-property-became-required
- ○
the response property
participants/items/conference_sidbecame required for the status200response-property-became-required
- ○
the response property
participants/items/date_createdbecame required for the status200response-property-became-required
- ○
the response property
participants/items/date_updatedbecame required for the status200response-property-became-required
- ○
the response property
participants/items/end_conference_on_exitbecame required for the status200response-property-became-required
- ○
the response property
participants/items/holdbecame required for the status200response-property-became-required
- ○
the response property
participants/items/mutedbecame required for the status200response-property-became-required
- ○
the response property
participants/items/start_conference_on_enterbecame required for the status200response-property-became-required
- ○
the response property
participants/items/statusbecame required for the status200response-property-became-required
- ○
the response property
participants/items/uribecame required for the status200response-property-became-required
- ○
the response property
previous_page_uribecame required for the status200response-property-became-required
- ○
the response property
uribecame required for the status200response-property-became-required
This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
the response property
participants/items/call_sid_to_coachbecame nullable for the status200response-property-became-nullable
- ▲
the response property
previous_page_uribecame nullable for the status200response-property-became-nullable
- ▲
- ▲
added the new path request parameter
AccountSidnew-request-path-parameter
- ▲
added the new path request parameter
ConferenceSidnew-request-path-parameter
- ▲
the response's body type/format changed from
/toobject/for status200response-body-type-changed
- ○
added the new optional
queryrequest parameterHoldnew-optional-request-parameter
- ○
added the new optional
queryrequest parameterMutednew-optional-request-parameter
- ○
removed
subschema #1subschema #2from the response bodyallOflist for the response status200response-body-all-of-removed
- ○
added the non-success response with the status
401response-non-success-status-added
- ○
added the optional property
account_sidto the response with the200statusresponse-optional-property-added
- ○
added the optional property
conference_sidto the response with the200statusresponse-optional-property-added
- ○
added the optional property
first_page_urito the response with the200statusresponse-optional-property-added
- ○
added the optional property
next_page_urito the response with the200statusresponse-optional-property-added
- ○
added the optional property
pageto the response with the200statusresponse-optional-property-added
- ○
added the optional property
page_sizeto the response with the200statusresponse-optional-property-added
- ○
added the optional property
participantsto the response with the200statusresponse-optional-property-added
- ○
added the optional property
previous_page_urito the response with the200statusresponse-optional-property-added
- ○
added the optional property
urito the response with the200statusresponse-optional-property-added
This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲