Room Recordings

Rooms Recordings operations.

Delete several room recordings in a bulk.

SecurityBearerAuth
Request
query Parameters
filter[date_ended_at][eq]
string <date>

ISO 8601 date for filtering room recordings ended on that date.

Example: filter[date_ended_at][eq]=2021-04-25
filter[date_ended_at][gte]
string <date>

ISO 8601 date for filtering room recordings ended after that date.

Example: filter[date_ended_at][gte]=2021-04-25
filter[date_ended_at][lte]
string <date>

ISO 8601 date for filtering room recordings ended before that date.

Example: filter[date_ended_at][lte]=2021-04-25
filter[date_started_at][eq]
string <date>

ISO 8601 date for filtering room recordings started on that date.

Example: filter[date_started_at][eq]=2021-04-25
filter[date_started_at][gte]
string <date>

ISO 8601 date for filtering room recordings started after that date.

Example: filter[date_started_at][gte]=2021-04-25
filter[date_started_at][lte]
string <date>

ISO 8601 date for filtering room recordings started before that date.

Example: filter[date_started_at][lte]=2021-04-25
filter[room_id]
string <uuid>

room_id for filtering room recordings.

Example: filter[room_id]=0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
filter[participant_id]
string <uuid>

participant_id for filtering room recordings.

Example: filter[participant_id]=0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
filter[session_id]
string <uuid>

session_id for filtering room recordings.

Example: filter[session_id]=0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
filter[status]
string

status for filtering room recordings.

Example: filter[status]=completed
filter[type]
string

type for filtering room recordings.

Example: filter[type]=audio
filter[duration_secs][eq]
integer

duration_secs equal for filtering room recordings.

Example: filter[duration_secs][eq]=20
filter[duration_secs][lte]
integer

duration_secs less or equal for filtering room recordings.

Example: filter[duration_secs][lte]=20
filter[duration_secs][gte]
integer

duration_secs greater or equal for filtering room recordings.

Example: filter[duration_secs][gte]=20
page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

page[number]
integer >= 1
Default: 1

The page number to load

Responses
201

Successful response for Bulk Delete Room recordings requests

Response Schema: application/json
object
room_recordings
integer

Amount of room recordings affected

422

Unprocessable entity. Check the 'detail' field in response for details.

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
title
required
string
detail
string
object
meta
object
delete/room_recordings
Request samples 
Response samples 
application/json
{
  • "data": {
    • "room_recordings": 5
    }
}
View a list of room recordings.
SecurityBearerAuth 
Request 
query Parameters
filter[date_ended_at][eq]
string <date> 
ISO 8601 date for filtering room recordings ended on that date.


 
 Example:  filter[date_ended_at][eq]=2021-04-25
filter[date_ended_at][gte]
string <date> 
ISO 8601 date for filtering room recordings ended after that date.


 
 Example:  filter[date_ended_at][gte]=2021-04-25
filter[date_ended_at][lte]
string <date> 
ISO 8601 date for filtering room recordings ended before that date.


 
 Example:  filter[date_ended_at][lte]=2021-04-25
filter[date_started_at][eq]
string <date> 
ISO 8601 date for filtering room recordings started on that date.


 
 Example:  filter[date_started_at][eq]=2021-04-25
filter[date_started_at][gte]
string <date> 
ISO 8601 date for filtering room recordings started after that date.


 
 Example:  filter[date_started_at][gte]=2021-04-25
filter[date_started_at][lte]
string <date> 
ISO 8601 date for filtering room recordings started before that date.


 
 Example:  filter[date_started_at][lte]=2021-04-25
filter[room_id]
string <uuid> 
room_id for filtering room recordings.


 
 Example:  filter[room_id]=0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
filter[participant_id]
string <uuid> 
participant_id for filtering room recordings.


 
 Example:  filter[participant_id]=0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
filter[session_id]
string <uuid> 
session_id for filtering room recordings.


 
 Example:  filter[session_id]=0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
filter[status]
string
status for filtering room recordings.


 
 Example:  filter[status]=completed
filter[type]
string
type for filtering room recordings.


 
 Example:  filter[type]=audio
filter[duration_secs][eq]
integer
duration_secs equal for filtering room recordings.


 
 Example:  filter[duration_secs][eq]=20
filter[duration_secs][lte]
integer
duration_secs less or equal for filtering room recordings.


 
 Example:  filter[duration_secs][lte]=20
filter[duration_secs][gte]
integer
duration_secs greater or equal for filtering room recordings.


 
 Example:  filter[duration_secs][gte]=20
page[size]
integer  [ 1 .. 250 ] 
 Default:  20
The size of the page


 
page[number]
integer  >= 1 
 Default:  1
The page number to load


 
Responses 
200
List room recordings response.


Response Schema: application/json
Array of objects (RoomRecording) 
 
object (PaginationMeta) 
 
get/room_recordings
Request samples 
Response samples 
application/json
{
  • "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": {
    • "total_pages": 3,
    • "total_results": 55,
    • "page_number": 2,
    • "page_size": 25
    }
}
Delete a room recording.
Synchronously delete a Room Recording.


SecurityBearerAuth 
Request 
path Parameters
room_recording_id
required
string <uuid> 
The unique identifier of a room recording.


 
 Example:  0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
Responses 
204
The resource was deleted successfully.


404
Resource not found


Response Schema: application/json
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
delete/room_recordings/{room_recording_id}
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "title": "string",
  • "detail": "string",
  • "source": {
    • "pointer": "/json/pointer",
    • "parameter": "string"
    },
  • "meta": { }
}
View a room recording.
SecurityBearerAuth 
Request 
path Parameters
room_recording_id
required
string <uuid> 
The unique identifier of a room recording.


 
 Example:  0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
Responses 
200
Get room recording response.


Response Schema: application/json
object (RoomRecording) 
 
codec
string
Shows the codec used for the room recording.


 
completed_at
string <datetime> 
ISO 8601 timestamp when the room recording has completed.


 
created_at
string <datetime> 
ISO 8601 timestamp when the room recording was created.


 
download_url
string
Url to download the recording.


 
duration_secs
integer
Shows the room recording duration in seconds.


 
ended_at
string <datetime> 
ISO 8601 timestamp when the room recording has ended.


 
id
string <uuid> 
A unique identifier for the room recording.


 
participant_id
string <uuid> 
Identify the room participant associated with the room recording.


 
record_type
string
 
room_id
string <uuid> 
Identify the room associated with the room recording.


 
session_id
string <uuid> 
Identify the room session associated with the room recording.


 
size_mb
number <float> 
Shows the room recording size in MB.


 
started_at
string <datetime> 
ISO 8601 timestamp when the room recording has stated.


 
status
string
Shows the room recording status.


 Enum: "completed" "processing"  
type
string
Shows the room recording type.


 Enum: "audio" "video"  
updated_at
string <datetime> 
ISO 8601 timestamp when the room recording was updated.


 
404
Resource not found


Response Schema: application/json
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
get/room_recordings/{room_recording_id}
Request samples 
Response samples 
application/json
{
  • "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"
    }
}