REST ClientVideoVideoRoomRecordings

get

View as MarkdownOpen in Claude

Retrieve a single room recording by its unique identifier.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the Room Recording.

Query parameters

media_ttlintegerOptional
Generated media links will be valid for this many seconds. Default is 900 (15 minutes).

Response

idstringRequiredformat: "uuid"
Unique ID of the Room Recording.
room_session_idstringRequiredformat: "uuid"
Unique ID of the Room Session the Room Recording was made in.
statusenum or nullRequired
Status of the recording.
Allowed values:
started_atdatetime or nullRequired
Timestamp of when the Room Recording started.
finished_atdatetime or nullRequired
Timestamp of when the Room Recording stopped.
durationinteger or nullRequired
The length of the Room Recording in seconds.
size_in_bytesinteger or nullRequired
The number of bytes of the Room Recording file.
formatstring or nullRequired
The MIME type of the Room Recording file.
cost_in_dollarsdoubleRequired
The cost of the recording in dollars.
uristring or nullRequired
A temporary URL for accessing the recording file. By default, valid for 15 minutes.
created_atdatetimeRequired
Timestamp when the recording was created.
updated_atdatetimeRequired
Timestamp when the recording was last updated.

Response Example

Response
1{
2  "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
3  "room_session_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
4  "status": "completed",
5  "started_at": "2022-01-01T10:00:00Z",
6  "finished_at": "2022-01-01T11:00:00Z",
7  "duration": 120,
8  "size_in_bytes": 20971520,
9  "format": "video/mp4",
10  "cost_in_dollars": 0.05,
11  "uri": "https://files.signalwire.com/temporary/link/to/the/recording/file",
12  "created_at": "2022-01-01T10:00:00Z",
13  "updated_at": "2022-01-01T11:00:00Z"
14}

Example

1from signalwire.rest import RestClient
2
3client = RestClient(
4    project="your-project-id",
5    token="your-api-token",
6    host="your-space.signalwire.com",
7)
8
9recording = client.video.room_recordings.get("recording-id")