Find a Room Recording by ID

View as Markdown

A detailed summary of a particular Room Recording.

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.

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) ```

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

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.
Allowed values:
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