List Room Sessions | SignalWire

curl https://{your_space_name}.signalwire.com/api/video/room_sessions \
     -u "<project_id>:<api_token>"

{
  "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": [
    {
      "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
      "room_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
      "name": "my_example_room",
      "display_name": "My Room's Name",
      "max_members": 20,
      "quality": "720p",
      "fps": 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",
      "record_on_start": false,
      "tone_on_entry_and_exit": true,
      "room_join_video_off": false,
      "user_join_video_off": false,
      "locked": false,
      "start_time": "2022-01-01T10:00:00Z",
      "end_time": "2022-01-01T11:00:00Z",
      "duration": 120,
      "status": "completed",
      "created_at": "2022-01-01T10:00:00Z",
      "updated_at": "2022-01-01T11:00:00Z",
      "preview_url": "https://example.signalwire.com/preview/abc123",
      "prioritize_handraise": false,
      "sync_audio_video": true,
      "cost_in_dollars": 0.05,
      "enable_room_previews": true,
      "locked_cover": "https://example.signalwire.com/locked-cover.png"
    }
  ]
}

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.

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)

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.

Permissions

Authentication

Query parameters

Response

Errors