Room object
Endpointhttps://api.100ms.live/v2/rooms
Object
| Argument | Description |
|---|---|
| id | Unique identifier for the room |
| name | Alias for the room |
| enabled | Indicates whether the room is enabled or disabled. Note: If you disable a room, that room can be used for only the current session and users will not be able to join the room later. You can use the Disable/Enable a room API with the enabled param set to true to enable the room again. |
| description | Description for the room |
| customer_id | Unique identifier for your account |
| customer (deprecated) | Unique identifier for your account same as customer_id |
| recording_info | Indicates whether the recording is enabled or disabled. Note: enabled argument in this object is only applicable to enable/disable SFU recording. Refer to RTMP Streaming & Browser Recording guide for other options. |
| template_id | Identifier for the template used for this room |
| template (deprecated) | Name for the template (This field is deprecated. To find template name, fetch template using template_id) |
| region | The region in which the room has to be created |
| large_room | Indicates whether the room is capable of supporting large number of peers (>2500) on the conferencing / live streaming setup or not. The client side SDKs are required to be updated to a certain version to support this update. Learn more about enabling large rooms here |
| size | Indicates the maximum number of peers who can join the given room |
| max_duration_seconds | Indicates the maximum running duration (in seconds) for the given room session before it ends automatically. |
| polls | Array of poll ids that this room will have. |
| webhook | Object of type webhook. This object encapsulates information pertaining to webhooks including URL and headers.It is designed for use in scenarios when there is a need to receive room events at a designated endpoint. For further details, please refer to the webhook arguments section. |
Postman collection
You can use our Postman collection to start exploring 100ms APIs.
Refer to the Postman guide to get started with 100ms API collection.
Have a suggestion? Recommend changes ->
