Skip to content Skip to navigation Skip to topbar

On this page

Conference Participant Resource

Twilio's Voice API Participant resource represents a participant who is either connecting to, or actively connected to, a conference that is not in completed status. This means that the Participants endpoint will not return results for participants whose call has ended, whose associated conference has ended, or whose call has been modified to use new TwiML; i.e. this resource does not return historical participant logs. For post-call participant details, use the Conference Insights Participant Summary resource.

The Participant resource allows you to:

Manipulate a conference's current participants by muting or removing them from the conference.
List of all the participants in an active conference.
Get information about a particular participant in an active conference.
Add participants to a conference.

(information)

Info

Tracking updates to all conference participants over the course of a conference can be done by using the Conference's statusCallback webhook.

Participant Properties

Property nameTypeRequiredDescriptionChild properties

accountSidSID<AC>

Optional

The SID of the Account that created the Participant resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

callSidSID<CA>

Optional

The SID of the Call the Participant resource is associated with.

Pattern: ^CA[0-9a-fA-F]{32}$Min length: 34Max length: 34

labelstring

Optional

The user-specified label of this participant, if one was given when the participant was created. This may be used to fetch, update or delete the participant.

callSidToCoachSID<CA>

Optional

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.

Pattern: ^CA[0-9a-fA-F]{32}$Min length: 34Max length: 34

coachingboolean

Optional

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.

conferenceSidSID<CF>

Optional

The SID of the conference the participant is in.

Pattern: ^CF[0-9a-fA-F]{32}$Min length: 34Max length: 34

dateCreatedstring<date-time-rfc-2822>

Optional

The date and time in GMT that the resource was created specified in RFC 2822 format.

dateUpdatedstring<date-time-rfc-2822>

Optional

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

endConferenceOnExitboolean

Optional

Whether the conference ends when the participant leaves. Can be: true or false and the default is false. If true, the conference ends and all other participants drop out when the participant leaves.

mutedboolean

Optional

Whether the participant is muted. Can be true or false.

holdboolean

Optional

Whether the participant is on hold. Can be true or false.

startConferenceOnEnterboolean

Optional

Whether the conference starts when the participant joins the conference, if it has not already started. Can be: true or false and the default is true. If false and the conference has not started, the participant is muted and hears background music until another participant starts the conference.

statusenum<string>

Optional

The status of the participant's call in a session. Can be: queued, connecting, ringing, connected, complete, or failed.

Possible values:

queuedconnectingringingconnectedcompletefailed

queueTimestring

Optional

The wait time in milliseconds before participant's call is placed. Only available in the response to a create participant request.

uristring

Optional

The URI of the resource, relative to https://api.twilio.com.

Create a Participant

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

Creates a Participant resource with either a ConferenceSid or FriendlyName initiates an outbound call and adds a new participant to the active Conference with that ConferenceSid or FriendlyName.

If an active conference does not exist with your FriendlyName, we create a new conference with that name and add the participant.

If a conference specified by ConferenceSid is not active, the request fails.

(information)

Calls Per Second (CPS)

By default, each account is granted one CPS for calls created via POST requests to the /Participants endpoint. Inbound calls and <Dial> calls are not limited by CPS. Accounts with an approved Business Profile can update their CPS up to 30 in the Twilio Console. In aggregate, calls are executed at the rate defined by the CPS. Individual calls may not execute at the anticipated rate — you may see individual seconds with more or fewer CPS, especially for inconsistent traffic — but over a month, the call execution rate will average the CPS rate set for that account.

(error)

Danger

Do not use personally identifiable information (PII) such as phone numbers, email addresses, a person's name, or any other sensitive information when assigning a FriendlyName to your conferences.

Path parameters

Property nameTypeRequiredPIIDescription

accountSidSID<AC>

required

The SID of the Account that will create the resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

conferenceSidstring

required

The SID of the participant's conference.

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

fromstring<endpoint>

required

The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in E.164 format (e.g., +16175551212). Client identifiers are formatted client:name. If using a phone number, it must be a Twilio number or a Verified outgoing caller id for your account. If the to parameter is a phone number, from must also be a phone number. If to is sip address, this value of from should be a username portion to be used to populate the P-Asserted-Identity header that is passed to the SIP endpoint.

tostring<endpoint>

required

The phone number, SIP address, or Client identifier that received this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as sip:name@company.com. Client identifiers are formatted client:name. Custom parameters may also be specified.

statusCallbackstring<uri>

Optional

The URL we should call using the status_callback_method to send status information to your application.

statusCallbackMethodenum<http-method>

Optional

The HTTP method we should use to call status_callback. Can be: GET and POST and defaults to POST.

Possible values:

GETPOST

statusCallbackEventarray[string]

Optional

The conference state changes that should generate a call to status_callback. Can be: initiated, ringing, answered, and completed. Separate multiple values with a space. The default value is completed.

labelstring

Optional

A label for this participant. If one is supplied, it may subsequently be used to fetch, update or delete the participant.

timeoutinteger

Optional

The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between 5 and 600, inclusive. The default value is 60. We always add a 5-second timeout buffer to outgoing calls, so value of 10 would result in an actual timeout that was closer to 15 seconds.

recordboolean

Optional

Whether to record the participant and their conferences, including the time between conferences. Can be true or false and the default is false.

mutedboolean

Optional

Whether the agent is muted in the conference. Can be true or false and the default is false.

beepstring

Optional

Whether to play a notification beep to the conference when the participant joins. Can be: true, false, onEnter, or onExit. The default value is true.

startConferenceOnEnterboolean

Optional

Whether to start the conference when the participant joins, if it has not already started. Can be: true or false and the default is true. If false and the conference has not started, the participant is muted and hears background music until another participant starts the conference.

endConferenceOnExitboolean

Optional

Whether to end the conference when the participant leaves. Can be: true or false and defaults to false.

waitUrlstring<uri>

Optional

The URL that Twilio calls using the wait_method before the conference has started. The URL may return an MP3 file, a WAV file, or a TwiML document. The default value is the URL of our standard hold music. If you do not want anything to play while waiting for the conference to start, specify an empty string by setting wait_url to ''. For more details on the allowable verbs within the waitUrl, see the waitUrl attribute in the <Conference> TwiML instruction.

waitMethodenum<http-method>

Optional

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.

Possible values:

GETPOST

earlyMediaboolean

Optional

Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. Can be: true or false and defaults to true.

maxParticipantsinteger

Optional

The maximum number of participants in the conference. Can be a positive integer from 2 to 250. The default value is 250.

conferenceRecordstring

Optional

Whether to record the conference the participant is joining. Can be: true, false, record-from-start, and do-not-record. The default value is false.

conferenceTrimstring

Optional

Whether to trim leading and trailing silence from the conference recording. Can be: trim-silence or do-not-trim and defaults to trim-silence.

conferenceStatusCallbackstring<uri>

Optional

The URL we should call using the conference_status_callback_method when the conference events in conference_status_callback_event occur. Only the value set by the first participant to join the conference is used. Subsequent conference_status_callback values are ignored.

conferenceStatusCallbackMethodenum<http-method>

Optional

The HTTP method we should use to call conference_status_callback. Can be: GET or POST and defaults to POST.

Possible values:

GETPOST

conferenceStatusCallbackEventarray[string]

Optional

The conference state changes that should generate a call to conference_status_callback. Can be: start, end, join, leave, mute, hold, modify, speaker, and announcement. Separate multiple values with a space. Defaults to start end.

recordingChannelsstring

Optional

The recording channels for the final recording. Can be: mono or dual and the default is mono.

recordingStatusCallbackstring<uri>

Optional

The URL that we should call using the recording_status_callback_method when the recording status changes.

recordingStatusCallbackMethodenum<http-method>

Optional

The HTTP method we should use when we call recording_status_callback. Can be: GET or POST and defaults to POST.

Possible values:

GETPOST

sipAuthUsernamestring

Optional

The SIP username used for authentication.

sipAuthPasswordstring

Optional

The SIP password for authentication.

regionstring

Optional

The region where we should mix the recorded audio. Can be:us1, us2, ie1, de1, sg1, br1, au1, or jp1.

conferenceRecordingStatusCallbackstring<uri>

Optional

The URL we should call using the conference_recording_status_callback_method when the conference recording is available.

conferenceRecordingStatusCallbackMethodenum<http-method>

Optional

The HTTP method we should use to call conference_recording_status_callback. Can be: GET or POST and defaults to POST.

Possible values:

GETPOST

recordingStatusCallbackEventarray[string]

Optional

The recording state changes that should generate a call to recording_status_callback. Can be: started, in-progress, paused, resumed, stopped, completed, failed, and absent. Separate multiple values with a space, ex: 'in-progress completed failed'.

conferenceRecordingStatusCallbackEventarray[string]

Optional

The conference recording state changes that generate a call to conference_recording_status_callback. Can be: in-progress, completed, failed, and absent. Separate multiple values with a space, ex: 'in-progress completed failed'

coachingboolean

Optional

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.

callSidToCoachSID<CA>

Optional

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.

Pattern: ^CA[0-9a-fA-F]{32}$Min length: 34Max length: 34

jitterBufferSizestring

Optional

Jitter buffer size for the connecting participant. Twilio will use this setting to apply Jitter Buffer before participant's audio is mixed into the conference. Can be: off, small, medium, and large. Default to large.

byocSID<BY>

Optional

The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that byoc is only meaningful when to is a phone number; it will otherwise be ignored. (Beta)

Pattern: ^BY[0-9a-fA-F]{32}$Min length: 34Max length: 34

callerIdstring

Optional

The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in E.164 format (e.g., +16175551212). Client identifiers are formatted client:name. If using a phone number, it must be a Twilio number or a Verified outgoing caller id for your account. If the to parameter is a phone number, callerId must also be a phone number. If to is sip address, this value of callerId should be a username portion to be used to populate the From header that is passed to the SIP endpoint.

callReasonstring

Optional

The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta)

recordingTrackstring

Optional

The audio track to record for the call. Can be: inbound, outbound or both. The default is both. inbound records the audio that is received by Twilio. outbound records the audio that is sent from Twilio. both records the audio that is received and sent by Twilio.

timeLimitinteger

Optional

The maximum duration of the call in seconds. Constraints depend on account and configuration.

machineDetectionstring

Optional

Whether to detect if a human, answering machine, or fax has picked up the call. Can be: Enable or DetectMessageEnd. Use Enable if you would like us to return AnsweredBy as soon as the called party is identified. Use DetectMessageEnd, if you would like to leave a message on an answering machine. For more information, see Answering Machine Detection.

machineDetectionTimeoutinteger

Optional

The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with AnsweredBy of unknown. The default timeout is 30 seconds.

machineDetectionSpeechThresholdinteger

Optional

The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400.

machineDetectionSpeechEndThresholdinteger

Optional

The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200.

machineDetectionSilenceTimeoutinteger

Optional

The number of milliseconds of initial silence after which an unknown AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000.

amdStatusCallbackstring<uri>

Optional

The URL that we should call using the amd_status_callback_method to notify customer application whether the call was answered by human, machine or fax.

amdStatusCallbackMethodenum<http-method>

Optional

The HTTP method we should use when calling the amd_status_callback URL. Can be: GET or POST and the default is POST.

Possible values:

GETPOST

trimstring

Optional

Whether to trim any leading and trailing silence from the participant recording. Can be: trim-silence or do-not-trim and the default is trim-silence.

callTokenstring

Optional

A token string needed to invoke a forwarded call. A call_token is generated when an incoming call is received on a Twilio number. Pass an incoming call's call_token value to a forwarded call via the call_token parameter when creating a new call. A forwarded call should bear the same CallerID of the original incoming call.

Create a Conference Participant

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function createParticipant() {
11  const participant = await client
12    .conferences("CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13    .participants.create({
14      beep: "onEnter",
15      earlyMedia: true,
16      from: "+15017122661",
17      label: "customer",
18      record: true,
19      statusCallback: "https://myapp.com/events",
20      statusCallbackEvent: ["ringing"],
21      to: "+15558675310",
22    });
23
24  console.log(participant.accountSid);
25}
26
27createParticipant();

Response

1{
2  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3  "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "label": "customer",
5  "conference_sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
6  "date_created": "Fri, 18 Feb 2011 21:07:19 +0000",
7  "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000",
8  "end_conference_on_exit": false,
9  "muted": false,
10  "hold": false,
11  "status": "queued",
12  "start_conference_on_enter": true,
13  "coaching": false,
14  "call_sid_to_coach": null,
15  "queue_time": "1000",
16  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
17}

Custom Parameters

(warning)

Warning

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 or label.

(warning)

Warning

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.

Path parameters

Property nameTypeRequiredPIIDescription

accountSidSID<AC>

required

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

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

conferenceSidSID<CF>

required

The SID of the conference with the participant to fetch.

Pattern: ^CF[0-9a-fA-F]{32}$Min length: 34Max length: 34

callSidstring

required

The Call SID or label of the participant to fetch. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20.

Fetch a Participant resource

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchParticipant() {
11  const participant = await client
12    .conferences("CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .participants("CallSid")
14    .fetch();
15
16  console.log(participant.accountSid);
17}
18
19fetchParticipant();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "call_sid": "CallSid",
4  "label": null,
5  "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "date_created": "Fri, 18 Feb 2011 21:07:19 +0000",
7  "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000",
8  "end_conference_on_exit": false,
9  "muted": false,
10  "hold": false,
11  "status": "connected",
12  "start_conference_on_enter": true,
13  "coaching": true,
14  "call_sid_to_coach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
15  "queue_time": null,
16  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
17}

Fetch a Participant resource by label

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchParticipant() {
11  const participant = await client
12    .conferences("CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .participants("customer")
14    .fetch();
15
16  console.log(participant.label);
17}
18
19fetchParticipant();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "call_sid": "customer",
4  "label": "customer",
5  "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "date_created": "Fri, 18 Feb 2011 21:07:19 +0000",
7  "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000",
8  "end_conference_on_exit": false,
9  "muted": false,
10  "hold": false,
11  "status": "connected",
12  "start_conference_on_enter": true,
13  "coaching": true,
14  "call_sid_to_coach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
15  "queue_time": null,
16  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
17}

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.

Path parameters

Property nameTypeRequiredPIIDescription

accountSidSID<AC>

required

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

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

conferenceSidSID<CF>

required

The SID of the conference with the participants to read.

Pattern: ^CF[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

mutedboolean

Optional

Whether to return only participants that are muted. Can be: true or false.

holdboolean

Optional

Whether to return only participants that are on hold. Can be: true or false.

coachingboolean

Optional

Whether to return only participants who are coaching another call. Can be: true or false.

pageSizeinteger<int64>

Optional

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

pageinteger

Optional

The page index. This value is simply for client state.

Minimum: 0

pageTokenstring

Optional

The page token. This is provided by the API.

Read multiple Participant resources

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listParticipant() {
11  const participants = await client
12    .conferences("CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .participants.list({
14      muted: true,
15      limit: 20,
16    });
17
18  participants.forEach((p) => console.log(p.accountSid));
19}
20
21listParticipant();

Response

1{
2  "participants": [
3    {
4      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5      "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6      "label": null,
7      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
8      "date_created": "Sat, 19 Feb 2011 21:07:19 +0000",
9      "date_updated": "Sat, 19 Feb 2011 21:07:19 +0000",
10      "end_conference_on_exit": false,
11      "muted": true,
12      "hold": false,
13      "status": "connected",
14      "start_conference_on_enter": true,
15      "coaching": true,
16      "call_sid_to_coach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
17      "queue_time": null,
18      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
19    },
20    {
21      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
22      "call_sid": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
23      "label": null,
24      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
25      "date_created": "Sat, 19 Feb 2011 21:07:19 +0000",
26      "date_updated": "Sat, 19 Feb 2011 21:07:19 +0000",
27      "end_conference_on_exit": false,
28      "muted": true,
29      "hold": false,
30      "status": "connected",
31      "start_conference_on_enter": true,
32      "coaching": false,
33      "call_sid_to_coach": null,
34      "queue_time": null,
35      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json"
36    }
37  ],
38  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0",
39  "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=1&PageToken=PACPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
40  "previous_page_uri": null,
41  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0",
42  "page": 0,
43  "page_size": 2,
44  "start": 0,
45  "end": 1
46}

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.

Path parameters

Property nameTypeRequiredPIIDescription

accountSidSID<AC>

required

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

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

conferenceSidSID<CF>

required

The SID of the conference with the participant to update.

Pattern: ^CF[0-9a-fA-F]{32}$Min length: 34Max length: 34

callSidstring

required

The Call SID or label of the participant to update. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20.

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

mutedboolean

Optional

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.

holdboolean

Optional

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.

holdUrlstring<uri>

Optional

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 <Play>, <Say>, <Pause>, or <Redirect> verbs.

holdMethodenum<http-method>

Optional

The HTTP method we should use to call hold_url. Can be: GET or POST and the default is GET.

Possible values:

GETPOST

announceUrlstring<uri>

Optional

The URL we call using the announce_method for an announcement to the participant. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>, <Say>, <Pause>, or <Redirect> verbs.

announceMethodenum<http-method>

Optional

The HTTP method we should use to call announce_url. Can be: GET or POST and defaults to POST.

Possible values:

GETPOST

waitUrlstring<uri>

Optional

The URL that Twilio calls using the wait_method before the conference has started. The URL may return an MP3 file, a WAV file, or a TwiML document. The default value is the URL of our standard hold music. If you do not want anything to play while waiting for the conference to start, specify an empty string by setting wait_url to ''. For more details on the allowable verbs within the waitUrl, see the waitUrl attribute in the <Conference> TwiML instruction.

waitMethodenum<http-method>

Optional

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.

Possible values:

GETPOST

beepOnExitboolean

Optional

Whether to play a notification beep to the conference when the participant exits. Can be: true or false.

endConferenceOnExitboolean

Optional

Whether to end the conference when the participant leaves. Can be: true or false and defaults to false.

coachingboolean

Optional

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.

callSidToCoachSID<CA>

Optional

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.

Pattern: ^CA[0-9a-fA-F]{32}$Min length: 34Max length: 34

Mute Participant

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateParticipant() {
11  const participant = await client
12    .conferences("CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .participants("CallSid")
14    .update({ muted: true });
15
16  console.log(participant.accountSid);
17}
18
19updateParticipant();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "call_sid": "CallSid",
4  "label": null,
5  "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "date_created": "Fri, 18 Feb 2011 21:07:19 +0000",
7  "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000",
8  "end_conference_on_exit": false,
9  "muted": true,
10  "hold": false,
11  "status": "connected",
12  "start_conference_on_enter": true,
13  "coaching": false,
14  "call_sid_to_coach": null,
15  "queue_time": null,
16  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
17}

Mute Participant by label

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateParticipant() {
11  const participant = await client
12    .conferences("CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .participants("customer")
14    .update({ muted: true });
15
16  console.log(participant.label);
17}
18
19updateParticipant();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "call_sid": "customer",
4  "label": "customer",
5  "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "date_created": "Fri, 18 Feb 2011 21:07:19 +0000",
7  "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000",
8  "end_conference_on_exit": false,
9  "muted": true,
10  "hold": false,
11  "status": "connected",
12  "start_conference_on_enter": true,
13  "coaching": false,
14  "call_sid_to_coach": null,
15  "queue_time": null,
16  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
17}

Place a participant on hold with music

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateParticipant() {
11  const participant = await client
12    .conferences("CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .participants("CallSid")
14    .update({
15      hold: true,
16      holdUrl: "http://www.myapp.com/hold_music",
17    });
18
19  console.log(participant.accountSid);
20}
21
22updateParticipant();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "call_sid": "CallSid",
4  "label": null,
5  "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "date_created": "Fri, 18 Feb 2011 21:07:19 +0000",
7  "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000",
8  "end_conference_on_exit": false,
9  "muted": false,
10  "hold": true,
11  "status": "connected",
12  "start_conference_on_enter": true,
13  "coaching": false,
14  "call_sid_to_coach": null,
15  "queue_time": null,
16  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
17}

Make an announcement to the participant

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateParticipant() {
11  const participant = await client
12    .conferences("CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .participants("CallSid")
14    .update({ announceUrl: "http://www.myapp.com/announce" });
15
16  console.log(participant.accountSid);
17}
18
19updateParticipant();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "call_sid": "CallSid",
4  "label": null,
5  "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "date_created": "Fri, 18 Feb 2011 21:07:19 +0000",
7  "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000",
8  "end_conference_on_exit": false,
9  "muted": false,
10  "hold": false,
11  "status": "connected",
12  "start_conference_on_enter": true,
13  "coaching": false,
14  "call_sid_to_coach": null,
15  "queue_time": null,
16  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
17}

Delete a Participant resource

DELETE 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.

Path parameters

Property nameTypeRequiredPIIDescription

accountSidSID<AC>

required

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

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

conferenceSidSID<CF>

required

The SID of the conference with the participants to delete.

Pattern: ^CF[0-9a-fA-F]{32}$Min length: 34Max length: 34

callSidstring

required

The Call SID or label of the participant to delete. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20.

Delete a Participant

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function deleteParticipant() {
11  await client
12    .conferences("CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .participants("CallSid")
14    .remove();
15}
16
17deleteParticipant();

Delete a Participant by label

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function deleteParticipant() {
11  await client
12    .conferences("CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .participants("customer")
14    .remove();
15}
16
17deleteParticipant();

What's next?

Explore Voice Insights with its Conference Insights Event Stream and Conference Insights REST API which allow you to see conference parameters, investigate participant event timelines, and understand detected quality issues.