Sign in
Room Recordings

Get room recording

Retrieves one Video Room recording by ID and returns a media link with the requested lifetime. Use it when you saved a recording ID or selected one from a recording list; voice-call recordings are available through the Recordings API instead.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Video.

Learn more about API scopes.

get/api/video/room_recordings/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the Room Recording.

Query parameters

media_ttlinteger

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

Response

Room recording response.

idstring uuid required

Universal Unique Identifier.

room_session_idstring uuid required

Universal Unique Identifier.

status'recording' | 'paused' | 'processing' | 'completed' required

Status of a room recording.

started_atstring date-time nullable required

Timestamp of when the Room Recording started.

finished_atstring date-time nullable required

Timestamp of when the Room Recording stopped.

durationinteger nullable required

The length of the Room Recording in seconds.

size_in_bytesinteger nullable required

The number of bytes of the Room Recording file.

formatstring nullable required

The MIME type of the Room Recording file.

cost_in_dollarsnumber double required

The cost of the recording in dollars.

uristring nullable required

A temporary URL for accessing the recording file. By default, valid for 15 minutes.

created_atstring date-time required

Timestamp when the recording was created.

updated_atstring date-time required

Timestamp when the recording was last updated.

Example response

{
  "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"
}

Changes

No changes found, but 3 of the 137 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.