Participants
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.
This resource represents a single Room participant, identified by the ParticipantSid or a ParticipantIdentity.
_10/v1/Rooms/{RoomNameOrSid}/Participants/{ParticipantIdentityOrSid}/
Resource properties
sid
type: SID<PA>
The unique string that we created to identify the RoomParticipant resource.
room_sid
type: SID<RM>
The SID of the participant's room.
status
type: enum<string>
The status of the Participant. Can be: connected
or disconnected
.
Possible values:
connected
disconnected
date_created
type: string<date-time>
date_updated
type: string<date-time>
start_time
type: string<date-time>
end_time
type: string<date-time>
duration
type: integer
The duration in seconds that the participant was connected
. Populated only after the participant is disconnected
.
url
type: string<uri>
The absolute URL of the resource.
links
type: object<uri-map>
The URLs of related resources.
Returns a single Participant resource represented by {ParticipantNameOrSid}
GET /Participants/{ParticipantIdentity}
implicitly searches only connected
Participants for the given ParticipantIdentity
and returns either an instance or a 404.
Will return the Participant instance object for the Participant Alice
whose Status is connected
, from the in-progress
Room named DailyStandup
.
_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
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11client.video.v1.rooms('DailyStandup')
_11 .participants('Alice')
_11 .then(participant => console.log(participant.sid));
_19 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19 "room_sid": "RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19 "date_created": "2015-07-30T20:00:00Z",
_19 "date_updated": "2015-07-30T20:00:00Z",
_19 "start_time": "2015-07-30T20:00:00Z",
_19 "sid": "PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19 "status": "connected",
_19 "url": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19 "published_tracks": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/PublishedTracks",
_19 "subscribed_tracks": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SubscribedTracks",
_19 "subscribe_rules": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SubscribeRules",
_19 "anonymize": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Anonymize"
Modifies a Participant resource.
URI parameters
RoomSid
type: string
The SID of the room with the participant to update.
Sid
type: string
The SID of the RoomParticipant resource to update.
Request body parameters
Status
type: enum<string>
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:
connected
disconnected
Update a Participant's status to disconnected
to remove the Participant from a Room.
_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
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11client.video.v1.rooms('DailyStandup')
_11 .participants('Alice')
_11 .update({status: 'disconnected'})
_11 .then(participant => console.log(participant.sid));
_19 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19 "room_sid": "RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19 "date_created": "2017-07-30T20:00:00Z",
_19 "date_updated": "2017-07-30T20:00:00Z",
_19 "start_time": "2017-07-30T20:00:00Z",
_19 "end_time": "2017-07-30T20:00:01Z",
_19 "sid": "PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19 "status": "disconnected",
_19 "url": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19 "published_tracks": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/PublishedTracks",
_19 "subscribed_tracks": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SubscribedTracks",
_19 "subscribe_rules": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SubscribeRules",
_19 "anonymize": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Anonymize"
_10/v1/Rooms/{RoomNameOrSid}/Participants/
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.
The following GET query string parameters allow you to limit the list returned. Note, parameters are case-sensitive.
URI parameters
RoomSid
type: string
The SID of the room with the Participant resources to read.
Status
type: enum<string>
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.
Possible values:
connected
disconnected
DateCreatedAfter
type: string<date-time>
DateCreatedBefore
type: string<date-time>
PageSize
type: integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
type: integer
The page index. This value is simply for client state.
PageToken
type: string
The page token. This is provided by the API.
_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
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11client.video.v1.rooms('DailyStandup')
_11 .list({status: 'connected', limit: 20})
_11 .then(participants => participants.forEach(p => console.log(p.sid)));
_32 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_32 "room_sid": "RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_32 "date_created": "2017-07-30T20:00:00Z",
_32 "date_updated": "2017-07-30T20:00:00Z",
_32 "start_time": "2017-07-30T20:00:00Z",
_32 "end_time": "2017-07-30T20:00:01Z",
_32 "sid": "PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_32 "status": "disconnected",
_32 "url": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_32 "published_tracks": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/PublishedTracks",
_32 "subscribed_tracks": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SubscribedTracks",
_32 "subscribe_rules": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SubscribeRules",
_32 "anonymize": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Anonymize"
_32 "first_page_url": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?Status=disconnected&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&Identity=alice&PageSize=50&Page=0",
_32 "previous_page_url": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?Status=disconnected&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&Identity=alice&PageSize=50&Page=0",
_32 "url": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?Status=disconnected&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&Identity=alice&PageSize=50&Page=0",
_32 "next_page_url": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?Status=disconnected&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&Identity=alice&PageSize=50&Page=1",
_32 "key": "participants"
_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
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11client.video.v1.rooms('DailyStandup')
_11 .list({status: 'disconnected', limit: 20})
_11 .then(participants => participants.forEach(p => console.log(p.sid)));
_32 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_32 "room_sid": "RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_32 "date_created": "2017-07-30T20:00:00Z",
_32 "date_updated": "2017-07-30T20:00:00Z",
_32 "start_time": "2017-07-30T20:00:00Z",
_32 "end_time": "2017-07-30T20:00:01Z",
_32 "sid": "PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_32 "status": "disconnected",
_32 "url": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_32 "published_tracks": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/PublishedTracks",
_32 "subscribed_tracks": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SubscribedTracks",
_32 "subscribe_rules": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SubscribeRules",
_32 "anonymize": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/PAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Anonymize"
_32 "first_page_url": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?Status=disconnected&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&Identity=alice&PageSize=50&Page=0",
_32 "previous_page_url": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?Status=disconnected&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&Identity=alice&PageSize=50&Page=0",
_32 "url": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?Status=disconnected&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&Identity=alice&PageSize=50&Page=0",
_32 "next_page_url": "https://video.twilio.com/v1/Rooms/RMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?Status=disconnected&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&Identity=alice&PageSize=50&Page=1",
_32 "key": "participants"