This page is for reference only. We are no longer onboarding new customers to Programmable Video. Existing customers can continue to use the product until December 5, 2024.
We recommend migrating your application to the API provided by our preferred video partner, Zoom. We've prepared this migration guide to assist you in minimizing any service disruption.
The Participants resource is a subresource of a Rooms instance resource. It represents participants currently connected to a given Room. A Participant instance resource represents an individual Room participant.
The Participant Instance resource lets you kick Participants out of a Room they are connected to. You can query the Participants List resource to get a list of participants currently connected to the Room. You can also get a list of Participants that are disconnected from the Room.
Participant Instance Resource
This resource represents a single Room participant, identified by the ParticipantSid or a ParticipantIdentity.
The application-defined string that uniquely identifies the resource's User within a Room. If a client joins with an existing Identity, the existing client is disconnected. See access tokens and limits for more info.
Returns a single Participant resource represented by {ParticipantNameOrSid}
Naming behavior
GET /Participants/{ParticipantIdentity} implicitly searches only connected Participants for the given ParticipantIdentity and returns either an instance or a 404.
Retrieve a connected Participant from a Room by Identity
Will return the Participant instance object for the Participant Alice whose Status is connected, from the in-progress Room named DailyStandup.
Retrieve a Participant
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl
_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
The new status of the resource. Can be: connected or disconnected. For in-progress Rooms the default Status is connected, for completed Rooms only disconnected Participants are returned.
Possible values:
connecteddisconnected
Kick/Remove Participant from a Room
Update a Participant's status to disconnected to remove the Participant from a Room.
Remove a Participant
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl
_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
Returns a list of Participant resources associated with this Room. The list includes paging information. You can filter the results by providing query string parameters.
List Filters
The following GET query string parameters allow you to limit the list returned. Note, parameters are case-sensitive.
Read only the participants with this status. Can be: connected or disconnected. For in-progress Rooms the default Status is connected, for completed Rooms only disconnected Participants are returned.