For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
        • DELDelete room recording
        • GETGet room recording
        • GETList room recording events
        • GETList room recordings
  • Datasphere
  • Logs
  • Messaging
  • Phone Number Management
  • Platform
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
CallingVideoRoom Recordings

Get room recording

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/video/room_recordings/:id
GET
/api/video/room_recordings/:id
$curl https://{your_space_name}.signalwire.com/api/video/room_recordings/id \
>     -u "<project_id>:<api_token>"
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}

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.

Was this page helpful?
Previous

List room recording events

Next
Built with

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>=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.
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

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error

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)