Get room recording

GET

https://{your_space_name}.signalwire.com/api/video/room_recordings/:id

Permissions

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

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](/docs/apis/rest/recordings/list-call-recordings) 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](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

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

Room recording response.

idstringformat: "uuid"

Unique ID of the Room Recording.

room_session_idstringformat: "uuid"

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

statusenum or null

Status of the recording.

started_atdatetime or null

Timestamp of when the Room Recording started.

finished_atdatetime or null

Timestamp of when the Room Recording stopped.

durationinteger or null

The length of the Room Recording in seconds.

size_in_bytesinteger or null

The number of bytes of the Room Recording file.

formatstring or null

The MIME type of the Room Recording file.

cost_in_dollarsdouble

The cost of the recording in dollars.

uristring or null

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

created_atdatetime

Timestamp when the recording was created.

updated_atdatetime

Timestamp when the recording was last updated.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error