Conference Participant Resource

Example JSON API response

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

Create an Agent Conference Participant

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

Custom Parameters

Only applies to Twilio Voice Client or SIP endpoints

Custom parameters can be passed to the specified client id or SIP endpoint in the to field using query string notation, e.g.

client:alice?mycustomparam1=foo&mycustomparam2=bar

Fetch a Participant resource

GET

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

Returns a Participant resource from 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.

パラメーター

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

Names in REST API format

account_sid

Path

GET sid<AC> Not PII

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

conference_sid

Path

GET sid<CF> Not PII

The SID of the conference with the participant to fetch.

call_sid

Path

GET sid<CA> Not PII

The Call SID of the resource to fetch.

例 1

Example JSON API response

Fetch a Participant resource

Read multiple Participant resources

GET

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

{ConferenceSid}で識別される、カンファレンスのアクティブな参加者の一覧を返します。

パラメーター

Names in REST API format
`account_sid` Path	GET sid<AC> Not PII The SID of the Account that created the Participant resources to read.
`conference_sid` Path	GET sid<CF> Not PII The SID of the conference with the participants to read.
`muted` オプション	GET boolean Not PII Whether to return only participants that are muted. Can be: `true` or `false`.
`hold` オプション	GET boolean Not PII Whether to return only participants that are on hold. Can be: `true` or `false`.
`coaching` オプション	GET boolean Not PII Whether to return only participants who are coaching another call. Can be: `true` or `false`.

例 1

Example JSON API response

Read multiple Participant resources

Update a Participant resource

post

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

Updates the status of a participant in an active conference.

パラメーター

Names in REST API format
`account_sid` Path	post sid<AC> Not PII The SID of the Account that created the Participant resources to update.
`conference_sid` Path	post sid<CF> Not PII The SID of the conference with the participant to update.
`call_sid` Path	post sid<CA> Not PII The Call SID of the resources to update.
`muted` オプション	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` オプション	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` オプション	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` オプション	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` オプション	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` オプション	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` オプション	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` オプション	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` オプション	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` オプション	post boolean Not PII Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`.
`coaching` オプション	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` オプション	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`.

例 1

Example JSON API response

Update a Participant resource to mute a participant

例 2

Example JSON API response

Update a Participant resource to place a participant on hold with music

例 3

Example JSON API response

Plays the audio file at the announce_url for the participant

Update a Participant resource to make an announcement to the participant

Plays the audio file at the announce_url for the participant

Delete a Participant resource

削除する

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

Deletes the Participant resource to remove the participant from the conference. Returns HTTP 204 (No Content) with no body if the participant was successfully removed from the conference.

パラメーター

Names in REST API format
`account_sid` Path	削除する sid<AC> Not PII The SID of the Account that created the Participant resources to delete.
`conference_sid` Path	削除する sid<CF> Not PII The SID of the conference with the participants to delete.
`call_sid` Path	削除する sid<CA> Not PII The Call SID of the resources to delete.

Names in REST API format

account_sid

Path

削除する sid<AC> Not PII

The SID of the Account that created the Participant resources to delete.

conference_sid

Path

削除する sid<CF> Not PII

The SID of the conference with the participants to delete.

call_sid

Path

削除する sid<CA> Not PII

The Call SID of the resources to delete.

例 1