View a room recording.

GET 
/room_recordings/:room_recording_id

View a room recording.

Request

Path Parameters

room_recording_id uuidrequired

The unique identifier of a room recording.

Responses

200: Get room recording response.

application/json

• Schema
• Example (from schema)

Schema

data

object

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

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

404: Resource not found

application/json

• Schema
• Example (from schema)

Schema

code intrequired
title stringrequired
detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

{
  "code": "string",
  "title": "string",
  "detail": "string",
  "source": {
    "pointer": "string",
    "parameter": "string"
  },
  "meta": {}
}

Loading...