REST ClientVideoVideoRooms

list

View as MarkdownOpen in Claude

List video rooms in the project.

Query parameters

include_active_sessionbooleanOptional
Specifies whether or not to include information about the room's active session (if any).
starts_afterstringOptional
Return rooms with a join_from date on or after this date. Expects RFC 3339 datetime or date string.
ends_beforestringOptional
Return rooms with a join_until date on or before this date. Expects RFC 3339 datetime or date string.
page_numberintegerOptional>=0Defaults to 0
Page number to return. Requires `page_token` for values greater than 0.
page_sizeintegerOptional1-1000Defaults to 50
Specify the number of results to return on a single page. The default page size is `50` and the maximum is `1000`.
page_tokenstringOptional
Token for cursor-based pagination. Required when `page_number` is greater than 0.

Response

datalist of objectsRequired
List of rooms.

Response Example

Response
1{
2  "links": {
3    "self": "https://example.signalwire.com/api/video/rooms?page=2",
4    "first": "https://example.signalwire.com/api/video/rooms?page=1",
5    "next": "https://example.signalwire.com/api/video/rooms?page=3",
6    "prev": "https://example.signalwire.com/api/video/rooms?page=1"
7  },
8  "data": [
9    {
10      "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
11      "name": "my_room",
12      "display_name": "My Room's Name",
13      "description": "This room will be used for full company all hands meetings",
14      "max_members": 20,
15      "quality": "720p",
16      "fps": 20,
17      "join_from": "2022-01-01T00:00:00Z",
18      "join_until": "2022-12-31T23:59:59Z",
19      "remove_at": "2022-12-31T23:59:59Z",
20      "remove_after_seconds_elapsed": 120,
21      "layout": "grid-responsive",
22      "record_on_start": false,
23      "tone_on_entry_and_exit": true,
24      "room_join_video_off": false,
25      "user_join_video_off": false,
26      "enable_room_previews": false,
27      "sync_audio_video": true,
28      "meta": {},
29      "prioritize_handraise": false,
30      "created_at": "2022-01-01T10:00:00Z",
31      "updated_at": "2022-01-01T11:00:00Z",
32      "active_session": {
33        "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
34        "room_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
35        "name": "my_example_room",
36        "display_name": "My Room's Name",
37        "join_from": "2022-01-01T00:00:00Z",
38        "join_until": "2022-12-31T23:59:59Z",
39        "remove_at": "2022-12-31T23:59:59Z",
40        "remove_after_seconds_elapsed": 120,
41        "layout": "grid-responsive",
42        "max_members": 20,
43        "fps": 20,
44        "quality": "720p",
45        "start_time": "2022-01-01T10:00:00Z",
46        "end_time": "2022-01-01T11:00:00Z",
47        "duration": 120,
48        "status": "completed",
49        "record_on_start": true,
50        "enable_room_previews": true,
51        "preview_url": "https://example.signalwire.com/api/video/room_sessions/c22d24f6-5a47-4597-9a23-c7d01e696b92/preview",
52        "audio_video_sync": true
53      }
54    }
55  ]
56}

Example

1from signalwire.rest import RestClient
2
3client = RestClient(
4    project="your-project-id",
5    token="your-api-token",
6    host="your-space.signalwire.com",
7)
8
9rooms = client.video.rooms.list()