Update room participant

POST /v1/Rooms/{RoomSid}/Participants/{Sid}
Account sid auth token

Participants in video rooms

Path parameters

  • RoomSid string Required

    The SID of the room with the participant to update.

  • Sid string Required

    The SID of the RoomParticipant resource to update.

application/x-www-form-urlencoded

Body

  • Status string

    The status of the Participant. Can be: connected or disconnected.

    Values are connected, disconnected, or reconnecting.

Responses

  • 202 application/json

    Accepted

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • sid string | null

      The unique string that we created to identify the RoomParticipant resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^PA[0-9a-fA-F]{32}$.

    • room_sid string | null

      The SID of the participant's room.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RM[0-9a-fA-F]{32}$.

    • account_sid string | null

      The SID of the Account that created the RoomParticipant resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • status string

      The status of the Participant. Can be: connected or disconnected.

      Values are connected, disconnected, or reconnecting.

    • identity string | null

      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.

    • date_created string(date-time) | null

      The date and time in GMT when the resource was created specified in ISO 8601 format.

    • date_updated string(date-time) | null

      The date and time in GMT when the resource was last updated specified in ISO 8601 format.

    • start_time string(date-time) | null

      The time of participant connected to the room in ISO 8601 format.

    • end_time string(date-time) | null

      The time when the participant disconnected from the room in ISO 8601 format.

    • duration integer | null

      The duration in seconds that the participant was connected. Populated only after the participant is disconnected.

    • url string(uri) | null

      The absolute URL of the resource.

    • links object(uri-map) | null

      The URLs of related resources.
POST /v1/Rooms/{RoomSid}/Participants/{Sid} 
curl \
 --request POST 'https://video.twilio.com/v1/Rooms/{RoomSid}/Participants/{Sid}' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Status=disconnected'
Request example 
{"Status"=>"disconnected"}
Response examples (202) 
{
  "sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "anonymize": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize",
    "subscribe_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribeRules",
    "published_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks",
    "subscribed_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks"
  },
  "status": "disconnected",
  "duration": 1,
  "end_time": "2017-07-30T20:00:01Z",
  "identity": "alice",
  "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "start_time": "2017-07-30T20:00:00Z",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2017-07-30T20:00:00Z",
  "date_updated": "2017-07-30T20:00:00Z"
}