Menu

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

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.

Participant Instance Resource

This resource represents a single Room participant, identified by the ParticipantSid or a ParticipantIdentity.

Resource URI

    /v1/Rooms/{RoomNameOrSid}/Participants/{ParticipantIdentityOrSid}/

Resource Properties

Names in PHP format
sid
sid<PA> Not PII

A 34 character string that uniquely identifies this resource.

roomSid
sid<RM> Not PII

A system-generated 34-character string that uniquely identifies. this room

accountSid
sid<AC> Not PII

The unique ID of the Account associated with this Room.

status
enum:status Not PII

A string representing the status of the Participant. If can be one of connected or disconnected.

identity
string Not PII

The unique name identifier that is assigned to this Participant. Identities are unique within a Room. If a client joins with an existing Identity, the existing client is disconnected.

dateCreated
date_time<iso8601> Not PII

The date that this resource was created, given as a UTC ISO 8601 Timestamp.

dateUpdated
date_time<iso8601> Not PII

The date that this resource was last updated, given as a UTC ISO 8601 Timestamp.

startTime
date_time<iso8601> Not PII

The time of Participant connected to the Room, given as a UTC ISO 8601 Timestamp.

endTime
date_time<iso8601> Not PII

The time of Participant disconnected from the Room, given as a UTC ISO 8601 Timestamp.

duration
integer? Not PII

Duration of time in seconds this Participant was connected. Populated only when disconnected.

url
url Not PII

The absolute URL for this resource.

links
uri_map Not PII

HTTP GET

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.

        
        
        
        

        HTTP POST

        Modifies a Participant resource.

        Names in PHP format
        roomSid
        Required
        post sid_like<RM> Not PII

        A system-generated 34-character string that uniquely identifies a Room.

        sid
        Required
        post sid_like<PA> Not PII

        A system-generated 34-character string that uniquely identifies this Participant.

        status
        Optional
        post enum:status Not PII

        Set to disconnected to remove participant.

        Kick/Remove Participant from a Room

        Update a Participant’s status to disconnected to remove the Participant from a Room.

              
              
              
              

              Participant List Resource

              Resource URI

              /v1/Rooms/{RoomNameOrSid}/Participants/
              

              HTTP GET

              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.

              Names in PHP format
              roomSid
              Required
              get sid_like<RM> Not PII

              A system-generated 34-character string that uniquely identifies this Room.

              status
              Optional
              get enum:status Not PII

              Only show Participants with the given Status. For in-progress Rooms the default Status is connected, for completed Rooms only disconnected Participants are returned.

              identity
              Optional
              get string Not PII

              Only show Participants that connected to the Room using the provided Identity.

              dateCreatedAfter
              Optional
              get date_time<iso8601> Not PII

              Only show Participants that started after this date, given as an UTC ISO 8601 Timestamp.

              dateCreatedBefore
              Optional
              get date_time<iso8601> Not PII

              Only show Participants that started before this date, given as an UTC ISO 8601 Timestamp.

                    
                    
                    
                    
                          
                          
                          
                          
                          Rate this page:

                          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 browsing the Twilio tag on Stack Overflow.