Sign in

v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-04-143933299.0 KB
VideoV1Room

post/v1/Rooms

Response

Created

sidstring nullable

The unique string that Twilio created to identify the Room resource.

status'in-progress' | 'completed' | 'failed'
date_createdstring date-time nullable

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

date_updatedstring date-time nullable

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

account_sidstring nullable

The SID of the Account that created the Room resource.

enable_turnboolean nullable

Deprecated, now always considered to be true.

unique_namestring nullable

An application-defined string that uniquely identifies the resource. It can be used as a room_sid in place of the resource's sid in the URL to address the resource, assuming it does not contain any reserved characters that would need to be URL encoded. This value is unique for in-progress rooms. SDK clients can use this name to connect to the room. REST API clients can use this name in place of the Room SID to interact with the room as long as the room is in-progress.

status_callbackstring uri nullable

The URL Twilio calls using the status_callback_method to send status information to your application on every room event. See Status Callbacks for more info.

status_callback_method'GET' | 'POST' http-method nullable

The HTTP method Twilio uses to call status_callback. Can be POST or GET and defaults to POST.

end_timestring date-time nullable

The UTC end time of the room in ISO 8601 format.

durationinteger nullable

The duration of the room in seconds.

type'group' | 'go' | 'peer-to-peer' | 'group-small'

Type of room. Use group for new implementations. go, peer-to-peer, and group-small are deprecated.

max_participantsinteger

The maximum number of concurrent Participants allowed in the room.

max_participant_durationinteger

The maximum number of seconds a Participant can be connected to the room. The maximum possible value is 86400 seconds (24 hours). The default is 14400 seconds (4 hours).

max_concurrent_published_tracksinteger nullable

The maximum number of published audio, video, and data tracks all participants combined are allowed to publish in the room at the same time. Check Programmable Video Limits for more details. If it is set to 0 it means unconstrained.

record_participants_on_connectboolean nullable

Whether to start recording when Participants connect.

video_codecsRoomEnumVideoCodec[] nullable

An array of the video codecs that are supported when publishing a track in the room. Can be: VP8 and H264.

media_regionstring nullable

The region for the Room's media server. Can be one of the available Media Regions.

audio_onlyboolean nullable

When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed.

empty_room_timeoutinteger

Specifies how long (in minutes) a room will remain active after last participant leaves. Can be configured when creating a room via REST API. For Ad-Hoc rooms this value cannot be changed.

unused_room_timeoutinteger

Specifies how long (in minutes) a room will remain active if no one joins. Can be configured when creating a room via REST API. For Ad-Hoc rooms this value cannot be changed.

large_roomboolean nullable

Indicates if this is a large room.

urlstring uri nullable

The absolute URL of the resource.

linksobject nullable

The URLs of related resources.