List video conferences
List Video Conferences.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Video.
Learn more about API scopes.
Query parameters
Return conferences with a join_from time on or after this timestamp. Accepts RFC 3339 datetime or Unix timestamp.
Return conferences with a join_until time on or before this timestamp. Accepts RFC 3339 datetime or Unix timestamp.
Specifies whether to include information about the conference's active session (if any).
Page number to return. Requires page_token for values greater than 0.
Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.
Token for cursor-based pagination. Required when page_number is greater than 0.
Response
The request has succeeded.
Example response
{
"links": {
"self": "https://example.signalwire.com/api/video/rooms?page=2",
"first": "https://example.signalwire.com/api/video/rooms?page=1",
"next": "https://example.signalwire.com/api/video/rooms?page=3",
"prev": "https://example.signalwire.com/api/video/rooms?page=1"
},
"data": [
{
"name": "my_conference",
"display_name": "My Conference's Name",
"description": "This conference will be used for full company all hands meetings",
"join_from": "2022-01-01T00:00:00Z",
"join_until": "2022-12-31T23:59:59Z",
"tone_on_entry_and_exit": true,
"enable_chat": true,
"dark_primary": "#044EF4",
"dark_background": "#FFFFFF",
"dark_foreground": "#1D2127",
"dark_success": "#17BB58",
"dark_negative": "#F42C50",
"light_primary": "#044EF4",
"light_background": "#FFFFFF",
"light_foreground": "#1D2127",
"light_success": "#17BB58",
"light_negative": "#F42C50",
"created_at": "2022-01-01T10:00:00Z",
"updated_at": "2022-01-01T11:00:00Z",
"active_session": {
"id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
"room_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
"name": "my_example_room",
"display_name": "My Room's Name",
"join_from": "2022-01-01T00:00:00Z",
"join_until": "2022-12-31T23:59:59Z",
"remove_at": "2022-12-31T23:59:59Z",
"remove_after_seconds_elapsed": 120,
"layout": "grid-responsive",
"max_members": 20,
"start_time": "2022-01-01T10:00:00Z",
"end_time": "2022-01-01T11:00:00Z",
"duration": 120,
"record_on_start": true,
"enable_room_previews": true,
"preview_url": "https://example.signalwire.com/api/video/room_sessions/c22d24f6-5a47-4597-9a23-c7d01e696b92/preview",
"audio_video_sync": true
}
}
]
}