Sign in
Room Recordings

Delete several room recordings in a bulk.

Deletes the room recordings that match the supplied filters and returns the number of recordings affected. Filters support room, session, participant, recording type, status, duration, and start or end dates.

delete/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

Successful response for Bulk Delete Room recordings requests

Example response

{
  "data": {
    "room_recordings": 5
  }
}

Changes

Changed in 2 of the 61 revisions of this API.2

  • 1571b0380bd71See the full diff
    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 422

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379941See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 422

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog