参加者
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インスタンス リソース
This resource represents a single Room participant, identified by the ParticipantSid or a ParticipantIdentity.
リソースURI
/v1/Rooms/{RoomNameOrSid}/Participants/{ParticipantIdentityOrSid}/
リソースのプロパティ
| Names in PHP format | |
|---|---|
sid
|
このリソースを一意に識別する 34 文字の文字列です。 |
roomSid
|
A system-generated 34-character string that uniquely identifies. this room |
accountSid
|
The unique ID of the Account associated with this Room. |
status
|
A string representing the status of the Participant. If can be one of |
identity
|
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
|
The date that this resource was created, given as a UTC ISO 8601 Timestamp. |
dateUpdated
|
The date that this resource was last updated, given as a UTC ISO 8601 Timestamp. |
startTime
|
The time of Participant connected to the Room, given as a UTC ISO 8601 Timestamp. |
endTime
|
The time of Participant disconnected from the Room, given as a UTC ISO 8601 Timestamp. |
duration
|
Duration of time in seconds this Participant was |
url
|
このリソースの絶対 URL です。 |
links
|
|
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
必須
|
A system-generated 34-character string that uniquely identifies a Room. |
sid
必須
|
A system-generated 34-character string that uniquely identifies this Participant. |
status
オプション
|
Set to |
Kick/Remove Participant from a Room
Update a Participant’s status to disconnected to remove the Participant from a Room.
Participant リスト リソース
リソース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.
リストフィルター
The following GET query string parameters allow you to limit the list returned. Note, parameters are case-sensitive.
| Names in PHP format | |
|---|---|
roomSid
必須
|
A system-generated 34-character string that uniquely identifies this Room. |
status
オプション
|
Only show Participants with the given Status. For |
identity
オプション
|
Only show Participants that connected to the Room using the provided Identity. |
dateCreatedAfter
オプション
|
Only show Participants that started after this date, given as an UTC ISO 8601 Timestamp. |
dateCreatedBefore
オプション
|
Only show Participants that started before this date, given as an UTC ISO 8601 Timestamp. |
ヘルプが必要ですか？
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.