REST API: Participants

The Participants list resource is a subresource of a Conference instance resource. It represents the set of participants currently connected to a particular conference. A Participant instance resource represents an individual conference participant.

Participant Instance Resource

This resource represents a single conference participant, identified by a CallSid.

Resource URI

/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}

Resource Properties

A Participant resource is represented by the following properties:

Property Description
CallSid A 34 character string that uniquely identifies the call that is connected to this conference
ConferenceSid A 34 character string that identifies the conference this participant is in
DateCreated The date that this resource was created, given in RFC 2822 format.
DateUpdated The date that this resource was last updated, given in RFC 2822 format.
AccountSid The unique id of the Account that created this conference
Muted true if this participant is currently muted. false otherwise.
StartConferenceOnEnter Was the startConferenceOnEnter attribute set on this participant (true or false)?
EndConferenceOnExit Was the endConferenceOnExit attribute set on this participant (true or false)?
Uri The URI for this resource, relative to https://api.twilio.com.

HTTP GET

Returns a representation of this participant:

Example 1
Try it now

  • GET /2010-04-01/Accounts/AC5ef87.../Conferences/CFbbe46.../Participants/CA386025c9bf5d6052a1d1ea42b4d16662 

    <TwilioResponse>
    <Participant>
        <CallSid>CA386025c9bf5d6052a1d1ea42b4d16662</CallSid>
        <ConferenceSid>CFbbe46ff1274e283f7e3ac1df0072ab39</ConferenceSid>
        <AccountSid>AC5ef872f6da5a21de157d80997a64bd33</AccountSid>
        <Muted>false</Muted>
        <EndConferenceOnExit>true</EndConferenceOnExit>
        <StartConferenceOnEnter>true</StartConferenceOnEnter>
        <DateCreated>Wed, 18 Aug 2010 20:20:10 +0000</DateCreated>
        <DateUpdated>Wed, 18 Aug 2010 20:20:10 +0000</DateUpdated>
        <Uri>/2010-04-01/Accounts/AC5ef872f6da5a21de157d80997a64bd33/Conferences/CFbbe46ff1274e283f7e3ac1df0072ab39/Participants/CA386025c9bf5d6052a1d1ea42b4d16662</Uri>
    </Participant>
</TwilioResponse>

HTTP POST

Updates the status of a participant.

Optional Parameters

You may update the properties of a participant via POSTing the following parameters:

Parameter Description
Muted Specifying true will mute the participant, while false will un-mute. Anything other than true or false is interpreted as false.
Example

Mute a participant.

Try it now

  • POST /2010-04-01/Accounts/AC5ef87.../Conferences/CFbbe46.../Participants/CA386025c9bf5d6052a1d1ea42b4d16662

    Muted=true

    <TwilioResponse>
    <Participant>
        <CallSid>CA386025c9bf5d6052a1d1ea42b4d16662</CallSid>
        <ConferenceSid>CFbbe46ff1274e283f7e3ac1df0072ab39</ConferenceSid>
        <AccountSid>AC5ef872f6da5a21de157d80997a64bd33</AccountSid>
        <Muted>true</Muted>
        <EndConferenceOnExit>true</EndConferenceOnExit>
        <StartConferenceOnEnter>true</StartConferenceOnEnter>
        <DateCreated>Wed, 18 Aug 2010 20:20:10 +0000</DateCreated>
        <DateUpdated>Wed, 18 Aug 2010 20:23:23 +0000</DateUpdated>
        <Uri>/2010-04-01/Accounts/AC5ef872f6da5a21de157d80997a64bd33/Conferences/CFbbe46ff1274e283f7e3ac1df0072ab39/Participants/CA386025c9bf5d6052a1d1ea42b4d16662</Uri>
    </Participant>
</TwilioResponse>

HTTP PUT

Not supported

HTTP DELETE

Kick this participant from the conference. Returns HTTP 204 (No Content), with no body, if the participant was successfully booted from the conference.

Example

DELETE /2010-04-01/Accounts/AC5ef87.../Conferences/CFbbe46.../Participants/CA386025c9bf5d6052a1d1ea42b4d16662

Participants List Resource

Resource URI

/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants

HTTP GET

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

List Filters

The following GET query string parameters allow you to limit the list returned. Note, parameters are case-sensitive:

Parameter Description
Muted Only show participants that are muted or unmuted. Either true or false.
Example
Try it now

  • GET /2010-04-01/Accounts/AC5ef87.../Conferences/CFbbe46.../Participants 

    <TwilioResponse>
    <Participants page="0" numpages=true pagesize="50" total="2" start="0" end=true uri="/2010-04-01/Accounts/AC5ef872f6da5a21de157d80997a64bd33/Conferences/CFbbe46ff1274e283f7e3ac1df0072ab39/Participants" firstpageuri="/2010-04-01/Accounts/AC5ef872f6da5a21de157d80997a64bd33/Conferences/CFbbe46ff1274e283f7e3ac1df0072ab39/Participants?Page=0&amp;PageSize=50" previouspageuri="" nextpageuri="" lastpageuri="/2010-04-01/Accounts/AC5ef872f6da5a21de157d80997a64bd33/Conferences/CFbbe46ff1274e283f7e3ac1df0072ab39/Participants?Page=0&amp;PageSize=50">
        <Participant>
            <ConferenceSid>CFbbe46ff1274e283f7e3ac1df0072ab39</ConferenceSid>
            <AccountSid>AC5ef872f6da5a21de157d80997a64bd33</AccountSid>
            <CallSid>CA386025c9bf5d6052a1d1ea42b4d16662</CallSid>
            <Muted>false</Muted>
            <EndConferenceOnExit>true</EndConferenceOnExit>
            <StartConferenceOnEnter>true</StartConferenceOnEnter>
            <DateCreated>Wed, 18 Aug 2010 20:20:10 +0000</DateCreated>
            <DateUpdated>Wed, 18 Aug 2010 20:20:10 +0000</DateUpdated>
            <Uri>/2010-04-01/Accounts/AC5ef872f6da5a21de157d80997a64bd33/Conferences/CFbbe46ff1274e283f7e3ac1df0072ab39/Participants/CA386025c9bf5d6052a1d1ea42b4d16662</Uri>
        </Participant>
        ...
    </Participants>
</TwilioResponse>

HTTP POST

Not supported

HTTP PUT

Not supported

HTTP DELETE

Not supported