Skip to main content

Conference Participants

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

AttributeType
account_sidstringThe unique identifier for the account that created this conference.
call_sidstringThe unique identifier for the Participant call connected to this conference.
call_sid_to_coachstringThe 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.
coachingbooleanWhether 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_sidstringThe unique identifier for the conference this participant is in.
date_createddatetimeThe date, in RFC 2822 format, this conference participant was created.
date_updateddatetimeThe date, in RFC 2822 format, this conference participant was updated.
end_conference_on_exitbooleanWhether or not a conference ends when a participant leaves the conference call. Possible values are true or false.
mutedbooleanWhether or not a participant is muted. Possible values are true or false.
holdbooleanWhether or not a participant is on hold. Possible values are true or false.
start_conference_on_enterbooleanWhether or not a conference will begin when this participant enters the conference call. Possible values are true or false.
uristringThe URI for this conference participant.

A sample participant returned from the API:

{
"account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
"call_sid": "b3877c40-da60-4998-90ad-b792e98472ca",
"conference_sid": "b3877c40-da60-4998-90ad-b792e98472pa",
"date_created": "Mon, 24 Sept 2018 21:00:00 +0000",
"date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
"end_conference_on_exit": false,
"muted": false,
"hold": false,
"status": "complete",
"start_conference_on_enter": true,
"coaching": false,
"call_sid_to_coach": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472pa/Participants/b3877c40-da60-4998-90ad-b792e98472ca.json"
}