REST Client Methods

Conference Participants

View as Markdown

Conference participants refer to the participants that are actively connected to a conference call. You can mute or remove participants from a conference as well as retrieve a list of all participants, along with detailed information about each participant, in an active conference.

Properties

account_sidstringRequiredformat: "uuid"
The unique identifier for the account that created this conference.
call_sidstringRequiredformat: "uuid"
The unique identifier for the Participant call connected to this conference.
call_sid_to_coachstring or nullRequiredformat: "uuid"
The unique identifier of the participant who is being coached.
coachingbooleanRequired
Whether the participant is coaching another call.
conference_sidstringRequiredformat: "uuid"
The unique identifier for the conference this participant is in.
date_createdstringRequired
The date, in RFC 2822 format, this conference participant was created.
statusenumRequired
The status of the conference call.
Allowed values:
date_updatedstringRequired
The date, in RFC 2822 format, this conference participant was updated.
end_conference_on_exitbooleanRequired
Whether or not a conference ends when a participant leaves the conference call.
mutedbooleanRequired
Whether or not a participant is muted.
holdbooleanRequired
Whether or not a participant is on hold.
start_conference_on_enterbooleanRequired
Whether or not a conference will begin when this participant enters the conference call.
uristringRequired
The URI for this conference participant.

Example object

The Conference Participant Object
1{
2  "account_sid": "string",
3  "call_sid": "string",
4  "call_sid_to_coach": "string",
5  "coaching": true,
6  "conference_sid": "string",
7  "date_created": "string",
8  "status": "completed",
9  "date_updated": "string",
10  "end_conference_on_exit": true,
11  "muted": true,
12  "hold": true,
13  "start_conference_on_enter": true,
14  "uri": "string"
15}