Conference Participant Resource
Twilio’s Voice API Participant resource represents a participant who is actively connected to a given conference.
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.
Tracking updates to all conference participants over the course of a conference can be done by using the Conference’s statusCallback
webhook.
Participant properties
Resource Properties in REST API format | |
---|---|
account_sid
|
The SID of the Account that created the Participant resource. |
call_sid
|
The SID of the Call the Participant resource is associated with. |
label
|
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. |
call_sid_to_coach
|
The SID of the participant who is being |
coaching
|
Whether the participant is coaching another call. Can be: |
conference_sid
|
The SID of the conference the participant is in. |
date_created
|
The date and time in GMT that the resource was created specified in RFC 2822 format. |
date_updated
|
The date and time in GMT that the resource was last updated specified in RFC 2822 format. |
end_conference_on_exit
|
Whether the conference ends when the participant leaves. Can be: |
muted
|
Whether the participant is muted. Can be |
hold
|
Whether the participant is on hold. Can be |
start_conference_on_enter
|
Whether the conference starts when the participant joins the conference, if it has not already started. Can be: |
status
|
The status of the participant's call in a session. Can be: |
uri
|
The URI of the resource, relative to |
Create a Participant
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.
Please 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.
Parameters
Parameters in REST API format | |
---|---|
account_sid
Path
|
The SID of the Account that will create the resource. |
conference_sid
Path
|
The SID of the participant's conference. |
from
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 |
to
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 |
status_callback
Optional
|
The URL we should call using the |
status_callback_method
Optional
|
The HTTP method we should use to call |
status_callback_event
Optional
|
The conference state changes that should generate a call to |
label
Optional
|
A label for this participant. If one is supplied, it may subsequently be used to fetch, update or delete the participant. |
timeout
Optional
|
The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between |
record
Optional
|
Whether to record the participant and their conferences, including the time between conferences. Can be |
muted
Optional
|
Whether the agent is muted in the conference. Can be |
beep
Optional
|
Whether to play a notification beep to the conference when the participant joins. Can be: |
start_conference_on_enter
Optional
|
Whether to start the conference when the participant joins, if it has not already started. Can be: |
end_conference_on_exit
Optional
|
Whether to end the conference when the participant leaves. Can be: |
wait_url
Optional
|
The URL we should call using the |
wait_method
Optional
|
The HTTP method we should use to call |
early_media
Optional
|
Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. Can be: |
max_participants
Optional
|
The maximum number of participants in the conference. Can be a positive integer from |
conference_record
Optional
|
Whether to record the conference the participant is joining. Can be: |
conference_trim
Optional
|
Whether to trim leading and trailing silence from the conference recording. Can be: |
conference_status_callback
Optional
|
The URL we should call using the |
conference_status_callback_method
Optional
|
The HTTP method we should use to call |
conference_status_callback_event
Optional
|
The conference state changes that should generate a call to |
recording_channels
Optional
|
The recording channels for the final recording. Can be: |
recording_status_callback
Optional
|
The URL that we should call using the |
recording_status_callback_method
Optional
|
The HTTP method we should use when we call |
sip_auth_username
Optional
|
The SIP username used for authentication. |
sip_auth_password
Optional
|
The SIP password for authentication. |
region
Optional
|
The region where we should mix the recorded audio. Can be: |
conference_recording_status_callback
Optional
|
The URL we should call using the |
conference_recording_status_callback_method
Optional
|
The HTTP method we should use to call |
recording_status_callback_event
Optional
|
The recording state changes that should generate a call to |
conference_recording_status_callback_event
Optional
|
The conference recording state changes that generate a call to |
coaching
Optional
|
Whether the participant is coaching another call. Can be: |
call_sid_to_coach
Optional
|
The SID of the participant who is being |
jitter_buffer_size
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: |
byoc
Optional
|
The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that |
caller_id
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 |
call_reason
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) |
recording_track
Optional
|
The audio track to record for the call. Can be: |
time_limit
Optional
|
The maximum duration of the call in seconds. Constraints depend on account and configuration. |
machine_detection
Optional
|
Whether to detect if a human, answering machine, or fax has picked up the call. Can be: |
machine_detection_timeout
Optional
|
The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with |
machine_detection_speech_threshold
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. |
machine_detection_speech_end_threshold
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. |
machine_detection_silence_timeout
Optional
|
The number of milliseconds of initial silence after which an |
amd_status_callback
Optional
|
The URL that we should call using the |
amd_status_callback_method
Optional
|
The HTTP method we should use when calling the |
trim
Optional
|
Whether to trim any leading and trailing silence from the participant recording. Can be: |
call_token
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. |
Example 1
Answering Machine Detection on requires Enhanced Programmable SIP Features to be enabled on the account.
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
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.
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
Parameters in REST API format | |
---|---|
account_sid
Path
|
The SID of the Account that created the Participant resource to fetch. |
conference_sid
Path
|
The SID of the conference with the participant to fetch. |
call_sid
Path
|
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. |
Example 1
Example 2
Read multiple Participant resources
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
Parameters in REST API format | |
---|---|
account_sid
Path
|
The SID of the Account that created the Participant resources to read. |
conference_sid
Path
|
The SID of the conference with the participants to read. |
muted
Optional
|
Whether to return only participants that are muted. Can be: |
hold
Optional
|
Whether to return only participants that are on hold. Can be: |
coaching
Optional
|
Whether to return only participants who are coaching another call. Can be: |
Example 1
Update a Participant resource
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json
Updates the status of a participant in an active conference.
Parameters
Parameters in REST API format | |
---|---|
account_sid
Path
|
The SID of the Account that created the Participant resources to update. |
conference_sid
Path
|
The SID of the conference with the participant to update. |
call_sid
Path
|
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. |
muted
Optional
|
Whether the participant should be muted. Can be |
hold
Optional
|
Whether the participant should be on hold. Can be: |
hold_url
Optional
|
The URL we call using the |
hold_method
Optional
|
The HTTP method we should use to call |
announce_url
Optional
|
The URL we call using the |
announce_method
Optional
|
The HTTP method we should use to call |
wait_url
Optional
|
The URL we call using the |
wait_method
Optional
|
The HTTP method we should use to call |
beep_on_exit
Optional
|
Whether to play a notification beep to the conference when the participant exits. Can be: |
end_conference_on_exit
Optional
|
Whether to end the conference when the participant leaves. Can be: |
coaching
Optional
|
Whether the participant is coaching another call. Can be: |
call_sid_to_coach
Optional
|
The SID of the participant who is being |
Example 1
Example 2
Example 3
Example 4
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.
Parameters
Parameters in REST API format | |
---|---|
account_sid
Path
|
The SID of the Account that created the Participant resources to delete. |
conference_sid
Path
|
The SID of the conference with the participants to delete. |
call_sid
Path
|
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. |
Example 1
Example 2
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.
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.