Update room

POST /v1/Rooms/{Sid}

Video rooms with one or more participants

Path parameters

Sid string Required

The SID of the Room resource to update.

application/x-www-form-urlencoded

Body

Status string Required

The new status of the resource. Set to completed to end the room.

Values are in-progress, completed, or failed.

Responses

• 200

OK
Hide response attributes Show response attributes object
- account_sid string | null
  
  The SID of the Account that created the resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- audio_only boolean | null
  
  Indicates whether the room will only contain audio track participants for group rooms.
- date_created string(date-time) | null
  
  The ISO 8601 date and time in GMT when the resource was created
- date_updated string(date-time) | null
  
  The ISO 8601 date and time in GMT when the resource was last updated
- duration integer | null
  
  The duration of the room in seconds
- empty_room_timeout integer | null
  
  The time a room will remain active after last participant leaves.
- enable_turn boolean | null
  
  Enable Twilio's Network Traversal TURN service
- end_time string(date-time) | null
  
  The UTC end time of the room in UTC ISO 8601 format
- large_room boolean | null
  
  Indicates if this is a large room.
- links object(uri-map) | null
  
  The URLs of related resources
- max_concurrent_published_tracks integer | null
  
  The maximum number of published tracks allowed in the room at the same time
- max_participant_duration integer | null
  
  The maximum number of seconds a Participant can be connected to the room
- max_participants integer | null
  
  The maximum number of concurrent Participants allowed in the room
- media_region string | null
  
  The region for the media server in Group Rooms
- record_participants_on_connect boolean | null
  
  Whether to start recording when Participants connect
- sid string | null
  
  The unique string that identifies the resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RM[0-9a-fA-F]{32}$.
- status string | null
  
  The status of the room
  
  Values are in-progress, completed, or failed.
- status_callback string(uri) | null
  
  The URL to send status information to your application
- status_callback_method string(http-method) | null
  
  The HTTP method we use to call status_callback
  
  Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
- type string | null
  
  The type of room
  
  Values are go, peer-to-peer, group, or group-small.
- unique_name string | null
  
  An application-defined string that uniquely identifies the resource
- unused_room_timeout integer | null
  
  The time a room will remain active when no one joins.
- url string(uri) | null
  
  The absolute URL of the resource
- video_codecs array[string] | null
  
  An array of the video codecs that are supported when publishing a track in the room
  
  Values are VP8 or H264.

POST /v1/Rooms/{Sid}

curl \
 -X POST https://video.twilio.com/v1/Rooms/{Sid} \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Status=in-progress'

Request example

{
  "Status": "in-progress"
}

Response examples (200)

{
  "account_sid": "string",
  "audio_only": true,
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "duration": 42,
  "empty_room_timeout": 42,
  "enable_turn": true,
  "end_time": "2023-05-04T09:42:00+00:00",
  "large_room": true,
  "links": {},
  "max_concurrent_published_tracks": 42,
  "max_participant_duration": 42,
  "max_participants": 42,
  "media_region": "string",
  "record_participants_on_connect": true,
  "sid": "string",
  "status": "in-progress",
  "status_callback": "https://example.com",
  "status_callback_method": "HEAD",
  "type": "go",
  "unique_name": "string",
  "unused_room_timeout": 42,
  "url": "https://example.com",
  "video_codecs": [
    "VP8"
  ]
}