Find a Room Recording by ID

GET 
/room_recordings/:id

A detailed summary of a particular Room Recording.

Permissions

The API token must include the following scopes: Video.

Request

Path Parameters

id uuidrequired

ID of room recording to return

Query Parameters

media_ttl integer
Generated media links will be valid for this many seconds. Default is 900 (15 minutes).
Example: 900

Responses

200

OK

application/json

Schema

Schema

iduuid

Unique ID of the Room Recording

room_session_iduuid

Unique ID of the Room Session the Room Recording was made in.

statusstring
Example: completed
started_atdate-time

Timestamp of when the Room Recording started.

finished_atdate-time

Timestamp of when the Room Recording stopped.

durationinteger
The length of the Room Recording in seconds.
Example: 120
size_in_bytesinteger
The number of bytes of the Room Recording file.
Example: 20971520
formatstring
The MIME type of the Room Recording file.
Example: video/mp4
uristring
A temporary URL for accessing your recording file. This URL, by default, is only valid for 15 minutes.
Example: https://files.signalwire.com/temporary/link/to/the/recording/file
created_atdate-time
updated_atdate-time

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "room_session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "completed",
  "started_at": "2024-07-29T15:51:28.071Z",
  "finished_at": "2024-07-29T15:51:28.071Z",
  "duration": 120,
  "size_in_bytes": 20971520,
  "format": "video/mp4",
  "uri": "https://files.signalwire.com/temporary/link/to/the/recording/file",
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}