v53

OpenAPI 3.1.0raw.githubusercontent.com2026-08-041,1941,9384.1 MB

Room Recordings

View a list of room recordings.

get/room_recordings

Query parameters

duration_secsinteger

duration_secs greater or equal for filtering room recordings.

participant_idstring uuid

participant_id for filtering room recordings.

room_idstring uuid

room_id for filtering room recordings.

session_idstring uuid

session_id for filtering room recordings.

statusstring

status for filtering room recordings.

typestring

type for filtering room recordings.

Consolidated filter parameter (deepObject style). Originally: filter[date_ended_at][eq], filter[date_ended_at][gte], filter[date_ended_at][lte], filter[date_started_at][eq], filter[date_started_at][gte], filter[date_started_at][lte], filter[room_id], filter[participant_id], filter[session_id], filter[status], filter[type], filter[duration_secs]

{
  "date_ended_at": {
    "eq": "2021-04-25",
    "gte": "2021-04-25",
    "lte": "2021-04-25"
  },
  "date_started_at": {
    "eq": "2021-04-25",
    "gte": "2021-04-25",
    "lte": "2021-04-25"
  },
  "duration_secs": 20,
  "participant_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
  "room_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
  "session_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
  "status": "completed",
  "type": "audio"
}

numberinteger

The page number to load.

sizeinteger

The size of the page.

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Response

List room recordings response.

Example response

{
  "data": [
    {
      "codec": "opus",
      "completed_at": "2021-04-16T10:25:55.962200Z",
      "created_at": "2021-04-16T09:46:20.954863Z",
      "download_url": "https://www.example.com",
      "duration_secs": 3660,
      "ended_at": "2021-04-16T10:24:55.962200Z",
      "id": "6b61621f-62e0-4aad-ab11-9fd19e272e73",
      "participant_id": "9b61621f-5fe4-4aad-ab11-9fd19e272e73",
      "record_type": "room_session",
      "room_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
      "session_id": "8b61621f-5fe4-4aad-ab11-9fd19e272e73",
      "size_mb": 5.6,
      "started_at": "2021-04-16T09:24:55.962200Z",
      "status": "completed",
      "type": "audio",
      "updated_at": "2021-04-16T10:24:55.962200Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}