get | SignalWire

Retrieve a single room recording by its unique identifier.

Path parameters

idstringRequiredformat: "uuid"

Unique ID of the Room Recording.

Query parameters

media_ttlintegerOptional>=0

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

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

Example

from signalwire.rest import RestClient
client = RestClient(
    project="your-project-id",
    token="your-api-token",
    host="your-space.signalwire.com",
)
recording = client.video.room_recordings.get("recording-id")