For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
        • GETGet room session
        • GETList room session events
        • GETList room session members
        • GETList room session recordings
        • GETList room sessions
  • Datasphere
  • Logs
  • Messaging
  • Phone Number Management
  • Platform
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
CallingVideoRoom Sessions

List room sessions

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/video/room_sessions
GET
/api/video/room_sessions
$curl https://{your_space_name}.signalwire.com/api/video/room_sessions \
>     -u "<project_id>:<api_token>"
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      "room_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
12      "name": "my_example_room",
13      "display_name": "My Room's Name",
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      "locked": false,
27      "start_time": "2022-01-01T10:00:00Z",
28      "end_time": "2022-01-01T11:00:00Z",
29      "duration": 120,
30      "status": "completed",
31      "created_at": "2022-01-01T10:00:00Z",
32      "updated_at": "2022-01-01T11:00:00Z",
33      "preview_url": "https://example.signalwire.com/preview/abc123",
34      "prioritize_handraise": false,
35      "sync_audio_video": true,
36      "cost_in_dollars": 0.05,
37      "enable_room_previews": true,
38      "locked_cover": "https://example.signalwire.com/locked-cover.png"
39    }
40  ]
41}

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.

Was this page helpful?
Previous

Create room token

Next
Built with

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Query parameters

room_idstringOptionalformat: "uuid"
Return Sessions started from this Room.
room_namestringOptional
Return Sessions with a matching room name.
room_name_matchesstringOptional

Return Sessions with a room name matching this pattern (substring match).

statusenumOptional
Return Sessions currently in this state.
Allowed values:
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

The request has succeeded.
linksobject
Pagination links.
datalist of objects
List of room sessions.

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)