Conference Participants

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.

get/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The unique identifier for the account that created this conference.

ConferenceSidstring uuid required

Universal Unique Identifier.

The unique identifier for the conference this participant is in.

Query parameters

Mutedboolean

Whether or not a participant is muted.

Holdboolean

Whether or not a participant is on hold.

Pageinteger

The page number to retrieve. Page numbers are zero-indexed, so the first page is 0.

PageSizeinteger

The number of results to return per page. The default is 50, and the maximum is 1000.

PageTokenstring

A token used to retrieve a specific page of results. Must start with PA or PB.

Response

The request has succeeded.

uristring required

The URI of the current page.

first_page_uristring required

The URI of the first page.

next_page_uristring nullable required

The URI of the next page.

previous_page_uristring nullable required

The URI of the previous page.

pageinteger required

The current page number.

page_sizeinteger required

The number of items per page.

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

  • 2916d5e3072e45See the full diff
    • the participants/items/account_sid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • the participants/items/call_sid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • the participants/items/call_sid_to_coach response's property type/format changed from /uuid to / for status 200

      response-property-type-changed

    • the participants/items/conference_sid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • added uuid to the participants/items/account_sid response property allOf list for the response status 200

      response-property-all-of-added

    • added uuid to the participants/items/call_sid response property allOf list for the response status 200

      response-property-all-of-added

    • added uuid to the participants/items/conference_sid response property allOf list for the response status 200

      response-property-all-of-added

    • added uuid to the participants/items/call_sid_to_coach response property anyOf list for the response status 200

      response-property-any-of-added

    • removed subschema #1 from the participants/items/call_sid_to_coach response property anyOf list for the response status 200

      response-property-any-of-removed

    • added 'unevaluatedProperties' constraint to the response body for the status 200

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the response body for the status 400

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the response body for the status 401

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the response body for the status 404

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the response body for the status 422

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the participants/items/ response property for the status 200

      response-property-unevaluated-properties-added

    • response property next_page_uri list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property participants/items/call_sid_to_coach list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property previous_page_uri list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

  • d5fbaaddfa3e3226See the full diff
    • the response property next_page_uri became nullable for the status 200

      response-property-became-nullable

    • the response property participants/items/call_sid_to_coach became nullable for the status 200

      response-property-became-nullable

    • the response property previous_page_uri became nullable for the status 200

      response-property-became-nullable

    • removed the optional property account_sid from the response with the 200 status

      response-optional-property-removed

    • removed the optional property conference_sid from the response with the 200 status

      response-optional-property-removed

    • added the new optional query request parameter Page

      new-optional-request-parameter

    • added the new optional query request parameter PageSize

      new-optional-request-parameter

    • added the new optional query request parameter PageToken

      new-optional-request-parameter

    • added the non-success response with the status 400

      response-non-success-status-added

    • added the non-success response with the status 404

      response-non-success-status-added

    • added the non-success response with the status 422

      response-non-success-status-added

    • the response property first_page_uri became required for the status 200

      response-property-became-required

    • the response property next_page_uri became required for the status 200

      response-property-became-required

    • the response property page became required for the status 200

      response-property-became-required

    • the response property page_size became required for the status 200

      response-property-became-required

    • the response property participants became required for the status 200

      response-property-became-required

    • the response property participants/items/account_sid became required for the status 200

      response-property-became-required

    • the response property participants/items/call_sid became required for the status 200

      response-property-became-required

    • the response property participants/items/call_sid_to_coach became required for the status 200

      response-property-became-required

    • the response property participants/items/coaching became required for the status 200

      response-property-became-required

    • the response property participants/items/conference_sid became required for the status 200

      response-property-became-required

    • the response property participants/items/date_created became required for the status 200

      response-property-became-required

    • the response property participants/items/date_updated became required for the status 200

      response-property-became-required

    • the response property participants/items/end_conference_on_exit became required for the status 200

      response-property-became-required

    • the response property participants/items/hold became required for the status 200

      response-property-became-required

    • the response property participants/items/muted became required for the status 200

      response-property-became-required

    • the response property participants/items/start_conference_on_enter became required for the status 200

      response-property-became-required

    • the response property participants/items/status became required for the status 200

      response-property-became-required

    • the response property participants/items/uri became required for the status 200

      response-property-became-required

    • the response property previous_page_uri became required for the status 200

      response-property-became-required

    • the response property uri became required for the status 200

      response-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_coach became nullable for the status 200

      response-property-became-nullable

    • the response property previous_page_uri became nullable for the status 200

      response-property-became-nullable

  • 3c88f14db21e313See the full diff
    • added the new path request parameter AccountSid

      new-request-path-parameter

    • added the new path request parameter ConferenceSid

      new-request-path-parameter

    • the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • added the new optional query request parameter Hold

      new-optional-request-parameter

    • added the new optional query request parameter Muted

      new-optional-request-parameter

    • removed subschema #1 subschema #2 from the response body allOf list for the response status 200

      response-body-all-of-removed

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the optional property account_sid to the response with the 200 status

      response-optional-property-added

    • added the optional property conference_sid to the response with the 200 status

      response-optional-property-added

    • added the optional property first_page_uri to the response with the 200 status

      response-optional-property-added

    • added the optional property next_page_uri to the response with the 200 status

      response-optional-property-added

    • added the optional property page to the response with the 200 status

      response-optional-property-added

    • added the optional property page_size to the response with the 200 status

      response-optional-property-added

    • added the optional property participants to the response with the 200 status

      response-optional-property-added

    • added the optional property previous_page_uri to the response with the 200 status

      response-optional-property-added

    • added the optional property uri to the response with the 200 status

      response-optional-property-added

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog