Get Video Room
GET/resources/video_rooms/:id
Returns a video room by ID.
Request
Path Parameters
id uuidrequired
Unique ID of the video room
Responses
- 200
A video room
- application/json
- Schema
- Example (from schema)
Schema
id uuid
Example:
993ed018-9e79-4e50-b97b-984bd5534095
project_id uuid
Example:
1313fe58-5e14-4c11-bbe7-6fdfa11fe780
display_name string
Example:
Reception
type string
Example:
video_room
created_at date-time
Example:
2024-01-02T00:00:00Z
updated_at date-time
Example:
2024-01-02T00:00:00Z
video_room
object
display_name string
Example:
Reception
max_members integer
Example:
30
quality string
Example:
720p
join_from date-time
Example:
2024-01-02T00:00:00Z
join_until date-time
Example:
2024-01-02T01:00:00Z
remove_at date-time
Example:
2024-01-02T02:00:00Z
remove_after_seconds_elapsed integer
Example:
3600
layout string
Example:
grid-responsive
record_on_start boolean
enable_room_previews boolean
sync_audio_video boolean
meta object
name string
Example:
reception
id uuid
fps integer
Example:
20
prioritize_hand_raise boolean
{
"id": "993ed018-9e79-4e50-b97b-984bd5534095",
"project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
"display_name": "Reception",
"type": "video_room",
"created_at": "2024-01-02T00:00:00Z",
"updated_at": "2024-01-02T00:00:00Z",
"video_room": {
"display_name": "Reception",
"max_members": 30,
"quality": "720p",
"join_from": "2024-01-02T00:00:00Z",
"join_until": "2024-01-02T01:00:00Z",
"remove_at": "2024-01-02T02:00:00Z",
"remove_after_seconds_elapsed": 3600,
"layout": "grid-responsive",
"record_on_start": true,
"enable_room_previews": true,
"sync_audio_video": true,
"meta": {},
"name": "reception",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fps": 20,
"prioritize_hand_raise": true
}
}