Room Recordings

Delete several room recordings in a bulk.

Changed on

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

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/room_recordings
  • Auth: HTTP bearer

Query parameters

room_idstring uuid

room_id for filtering room recordings.

participant_idstring uuid

participant_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.

duration_secsinteger

duration_secs greater or equal 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"
  },
  "room_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
  "participant_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
  "session_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
  "status": "completed",
  "type": "audio",
  "duration_secs": 20
}
sizeinteger

The size of the page.

numberinteger

The page number to load.

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

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status