Room is a virtual space that holds conferencing of the people. To allow users to join a 100ms video conferencing or a live streaming session inside your app, you first need to create a room.
Room APIs can be used to
- Create a room
- Get details of existing rooms based on id/name/enabled/created-time or combinations of these
- Disable an existing room
|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
|description||Description for the room|
|customer||Unique identifier for your account|
|recording_info||Indicates whether the recording is enabled or disabled. |
Note: This argument 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||Name for the template|
|region||The region in which the room has to be created|
You can use our Postman collection to start exploring 100ms APIs.
Refer to the Postman guide to get started with 100ms API collection.