Skip to main content

List all active Participants

The ability to read all of the active participants that are associated with this conference call. This will be returned as a list of participants.

Permissions

The API token must include the following scopes: Voice.

Path Parameters
AccountSid uuid REQUIRED

The unique identifier for the account that created this conference.

ConferenceSid uuid REQUIRED

The unique identifier for the conference this participant is in.

Query Parameters
Muted boolean

Whether or not a participant is muted. Possible values are true or false.

Hold boolean

Whether or not a participant is on hold. Possible values are true or false.

Responses
200

OK

Schema OPTIONAL
uri string OPTIONAL
first_page_uri string OPTIONAL
next_page_uri string OPTIONAL
previous_page_uri string OPTIONAL
page integer OPTIONAL
page_size integer OPTIONAL
account_sid uuid OPTIONAL

The unique identifier for the account that created this conference.

conference_sid uuid OPTIONAL

The unique identifier for the conference this participant is in.

participants object[] OPTIONAL
account_sid uuid OPTIONAL

The unique identifier for the account that created this conference.

call_sid uuid OPTIONAL

The unique identifier for the Participant call connected to this conference.

call_sid_to_coach uuid OPTIONAL

The unique identifier of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching.

coaching boolean OPTIONAL

Whether the participant is coaching another call. Possible values are true or false. If not present, defaults to false unless call_sid_to_coach is defined. If true, call_sid_to_coach must be defined.

conference_sid uuid OPTIONAL

The unique identifier for the conference this participant is in.

date_created string OPTIONAL

The date, in RFC 2822 format, this conference participant was created.

status string OPTIONAL

Possible values: [completed, in-progress]

The status of the conference call (?)

date_updated string OPTIONAL

The date, in RFC 2822 format, this conference participant was updated.

end_conference_on_exit boolean OPTIONAL

Whether or not a conference ends when a participant leaves the conference call. Possible values are true or false.

muted boolean OPTIONAL

Whether or not a participant is muted. Possible values are true or false.

hold boolean OPTIONAL

Whether or not a participant is on hold. Possible values are true or false.

start_conference_on_enter boolean OPTIONAL

Whether or not a conference will begin when this participant enters the conference call. Possible values are true or false.

uri string OPTIONAL

The URI for this conference participant.