Room Sessions
List room sessions
A list of past and in-progress Room Sessions.
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.
get/api/video/room_sessions
Query parameters
room_idstring uuid
Universal Unique Identifier.
Return Sessions started from this Room.
room_namestring
Return Sessions with a matching room name.
room_name_matchesstring
Return Sessions with a room name matching this pattern (substring match).
status'in-progress' | 'completed'
Status of a room session.
Return Sessions currently in this state.
page_numberinteger
Page number to return. Requires page_token for values greater than 0.
page_sizeinteger
Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.
page_tokenstring
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_example_room",
"display_name": "My Room's Name",
"max_members": 20,
"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",
"tone_on_entry_and_exit": true,
"start_time": "2022-01-01T10:00:00Z",
"end_time": "2022-01-01T11:00:00Z",
"duration": 120,
"created_at": "2022-01-01T10:00:00Z",
"updated_at": "2022-01-01T11:00:00Z",
"preview_url": "https://example.signalwire.com/preview/abc123",
"sync_audio_video": true,
"cost_in_dollars": 0.05,
"enable_room_previews": true,
"locked_cover": "https://example.signalwire.com/locked-cover.png"
}
]
}