Conference Participant

Output

Creates a Participant in an Agent Conference. If this ConferenceSid is not an active conference, the request will fail.

Create Agent Conference Participant

Creates a Participant in an Agent Conference. If this ConferenceSid is not an active conference, the request will fail.

Fetch a Participant resource

get

https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json

Return a Participant in an active Conference, specified by the Conference SID and the Participant's Call SID.

The Participant resource only manages active participants of in-progress Conferences.

If you want to get a list of all conference participants over the course of a conference, use the Conference's statusCallback to receive webhooks for each participant joining the conference and store the details in your application.

Parameters

Names in None format

Names in None format
`account_sid` Required	get sid<AC> Not PII The SID of the Account that created the Participant resource to fetch.
`conference_sid` Required	get sid<CF> Not PII The SID of the conference with the participant to fetch.
`call_sid` Required	get sid<CA> Not PII The Call SID of the resource to fetch.

account_sid

Required

get sid<AC> Not PII

The SID of the Account that created the Participant resource to fetch.

conference_sid

Required

get sid<CF> Not PII

The SID of the conference with the participant to fetch.

call_sid

Required

get sid<CA> Not PII

The Call SID of the resource to fetch.

Example

Output

Fetch Participant

Read multiple Participant resources

get

https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json

Returns the list of active participants in the conference identified by {ConferenceSid}.

Parameters

Names in None format
`account_sid` Required	get sid<AC> Not PII The SID of the Account that created the Participant resources to read.
`conference_sid` Required	get sid<CF> Not PII The SID of the conference with the participants to read.
`muted` Optional	get boolean Not PII Whether to return only participants that are muted. Can be: `true` or `false`.
`hold` Optional	get boolean Not PII Whether to return only participants that are on hold. Can be: `true` or `false`.
`coaching` Optional	get boolean Not PII Whether to return only participants who are coaching another call. Can be: `true` or `false`.

Example 1

Output

Read: retrieve all participants

Update a Participant resource

post

https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json

Update the status of a participant in an active conference.

Parameters

Names in None format
`account_sid` Required	post sid<AC> Not PII The SID of the Account that created the Participant resources to update.
`conference_sid` Required	post sid<CF> Not PII The SID of the conference with the participant to update.
`call_sid` Required	post sid<CA> Not PII The Call SID of the resources to update.
`muted` Optional	post boolean Not PII Whether the participant should be muted. Can be `true` or `false.`true`will mute the participant, and`false`will un-mute them. Anything value other than`true`or`false`is interpreted as`false`.
`hold` Optional	post boolean Not PII Whether the participant should be on hold. Can be: `true` or `false`. `true` puts the participant on hold, and `false` lets them rejoin the conference.
`hold_url` Optional	post url Not PII The URL we call using the `hold_method` for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains the `<Play>`, `<Say>` or `<Redirect>` commands.
`hold_method` Optional	post http_method Not PII The HTTP method we should use to call `hold_url`. Can be: `GET` or `POST` and the default is `GET`.
`announce_url` Optional	post url Not PII The URL we call using the `announce_method` for an announcement to the participant. The URL must return an MP3 file, a WAV file, or a TwiML document that contains `<Play>` or `<Say>` commands.
`announce_method` Optional	post http_method Not PII The HTTP method we should use to call `announce_url`. Can be: `GET` or `POST` and defaults to `POST`.
`wait_url` Optional	post url Not PII The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. Learn more about hold music.
`wait_method` Optional	post http_method Not PII The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.
`beep_on_exit` Optional	post boolean Not PII Whether to play a notification beep to the conference when the participant exits. Can be: `true` or `false`.
`end_conference_on_exit` Optional	post boolean Not PII Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`.
`coaching` Optional	post boolean Not PII Whether the participant is coaching another call. Can be: `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.
`call_sid_to_coach` Optional	post sid<CA> Not PII The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`.

Example 1

Output

Update: mute a participant

Example 2

Output

Update: Place a participant on hold with music

Example 3