Skip to main content

View a list of room recordings.

GET 

/room_recordings

Request

Query Parameters

    filter[date_ended_at][eq] date

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

    filter[date_ended_at][gte] date

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

    filter[date_ended_at][lte] date

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

    filter[date_started_at][eq] date

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

    filter[date_started_at][gte] date

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

    filter[date_started_at][lte] date

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

    filter[room_id] uuid

    room_id for filtering room recordings.

    filter[participant_id] uuid

    participant_id for filtering room recordings.

    filter[session_id] uuid

    session_id for filtering room recordings.

    filter[status] string

    status for filtering room recordings.

    filter[type] string

    type for filtering room recordings.

    filter[duration_secs][eq] integer

    duration_secs equal for filtering room recordings.

    filter[duration_secs][lte] integer

    duration_secs less or equal for filtering room recordings.

    filter[duration_secs][gte] integer

    duration_secs greater or equal for filtering room recordings.

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page.

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load.

Responses

200: List room recordings response.

Schema

    data

    object[]

  • Array [

  • id uuid

    A unique identifier for the room recording.

    room_id uuid

    Identify the room associated with the room recording.

    session_id uuid

    Identify the room session associated with the room recording.

    participant_id uuid

    Identify the room participant associated with the room recording.

    status string

    Possible values: [completed, processing]

    Shows the room recording status.

    type string

    Possible values: [audio, video]

    Shows the room recording type.

    size_mb float

    Shows the room recording size in MB.

    download_url string

    Url to download the recording.

    codec string

    Shows the codec used for the room recording.

    duration_secs integer

    Shows the room recording duration in seconds.

    created_at datetime

    ISO 8601 timestamp when the room recording was created.

    updated_at datetime

    ISO 8601 timestamp when the room recording was updated.

    ended_at datetime

    ISO 8601 timestamp when the room recording has ended.

    started_at datetime

    ISO 8601 timestamp when the room recording has stated.

    completed_at datetime

    ISO 8601 timestamp when the room recording has completed.

    record_type string
  • ]

  • meta

    object

    page_number integer
    page_size integer
    total_pages integer
    total_results integer
Loading...