REST ClientVideoVideoConferences

list

View as MarkdownOpen in Claude

List video conferences in the project.

Query parameters

starts_afterstringOptional
Return conferences with a `join_from` time on or after this timestamp. Accepts RFC 3339 datetime or Unix timestamp.
ends_beforestringOptional
Return conferences with a `join_until` time on or before this timestamp. Accepts RFC 3339 datetime or Unix timestamp.
include_active_sessionbooleanOptional
Specifies whether to include information about the conference's active session (if any).
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 conferences.

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_conference",
12      "display_name": "My Conference's Name",
13      "description": "This conference will be used for full company all hands meetings",
14      "join_from": "2022-01-01T00:00:00Z",
15      "join_until": "2022-12-31T23:59:59Z",
16      "quality": "720p",
17      "layout": "grid-responsive",
18      "size": "medium",
19      "record_on_start": false,
20      "tone_on_entry_and_exit": true,
21      "user_join_video_off": false,
22      "room_join_video_off": false,
23      "enable_chat": true,
24      "enable_room_previews": false,
25      "dark_primary": "#044EF4",
26      "dark_background": "#FFFFFF",
27      "dark_foreground": "#1D2127",
28      "dark_success": "#17BB58",
29      "dark_negative": "#F42C50",
30      "light_primary": "#044EF4",
31      "light_background": "#FFFFFF",
32      "light_foreground": "#1D2127",
33      "light_success": "#17BB58",
34      "light_negative": "#F42C50",
35      "meta": {},
36      "created_at": "2022-01-01T10:00:00Z",
37      "updated_at": "2022-01-01T11:00:00Z",
38      "active_session": {
39        "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
40        "room_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
41        "name": "my_example_room",
42        "display_name": "My Room's Name",
43        "join_from": "2022-01-01T00:00:00Z",
44        "join_until": "2022-12-31T23:59:59Z",
45        "remove_at": "2022-12-31T23:59:59Z",
46        "remove_after_seconds_elapsed": 120,
47        "layout": "grid-responsive",
48        "max_members": 20,
49        "fps": 20,
50        "quality": "720p",
51        "start_time": "2022-01-01T10:00:00Z",
52        "end_time": "2022-01-01T11:00:00Z",
53        "duration": 120,
54        "status": "completed",
55        "record_on_start": true,
56        "enable_room_previews": true,
57        "preview_url": "https://example.signalwire.com/api/video/room_sessions/c22d24f6-5a47-4597-9a23-c7d01e696b92/preview",
58        "audio_video_sync": true
59      }
60    }
61  ]
62}

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
9conferences = client.video.conferences.list()