/recordings
Last updated
Was this helpful?
Last updated
Was this helpful?
Returns the recordings.
The name of the room
The cursor for paginating through the results. To fetch the next page,
set the cursor to the cursor returned by the previous request.
8f4031bfc7640c5f267b11b6fe0c2507The limit for the pagination - the maximum number of results that will be returned within a single API response.
50Sort results by a field. Accepted fields are: roomName, startDate, duration and sizeInMegaBytes. Accepted sort values are 'asc' and 'desc'.
roomName:ascGET /v1/recordings HTTP/1.1
Host: api.whereby.dev
Accept: */*
{
"results": [
{
"recordingId": "a56f6ad7-37fe-4a37-9319-3174630ba57a",
"roomSessionId": "e2f29530-46ec-4cee-8b27-e565cb5bb2e9",
"filename": "recording.mp4",
"startDate": "2025-01-01T00:00:00.000Z",
"endDate": "2025-01-01T00:00:00.000Z",
"sizeInMegaBytes": 100
}
],
"cursor": "text"
}Returns the specified recording metadata.
Recording ID.
a56f6ad7-37fe-4a37-9319-3174630ba57a{"recordingId":"a56f6ad7-37fe-4a37-9319-3174630ba57a","roomSessionId":"e2f29530-46ec-4cee-8b27-e565cb5bb2e9","filename":"recording.mp4","startDate":"2025-01-01T00:00:00.000Z","endDate":"2025-01-01T00:00:00.000Z","sizeInMegaBytes":100}GET /v1/recordings/{recordingId} HTTP/1.1
Host: api.whereby.dev
Accept: */*
{
"recordingId": "a56f6ad7-37fe-4a37-9319-3174630ba57a",
"roomSessionId": "e2f29530-46ec-4cee-8b27-e565cb5bb2e9",
"filename": "recording.mp4",
"startDate": "2025-01-01T00:00:00.000Z",
"endDate": "2025-01-01T00:00:00.000Z",
"sizeInMegaBytes": 100
}Returns the access link for the specified recording. Available for Whereby-hosted recordings only
Recording ID.
a56f6ad7-37fe-4a37-9319-3174630ba57aThe number of seconds the access link is valid for.
3600GET /v1/recordings/{recordingId}/access-link HTTP/1.1
Host: api.whereby.dev
Accept: */*
{
"accessLink": "https://s3.eu-central-1.amazonaws.com/recordings/1.mp4?AWSAccessKeyId=AKIAJ...",
"expires": 1740819600000
}Deletes the specified recording. The endpoint is idempotent, meaning it will return the same response even if the recording has already been deleted.
Recording ID.
a56f6ad7-37fe-4a37-9319-3174630ba57aDELETE /v1/recordings/{recordingId} HTTP/1.1
Host: api.whereby.dev
Accept: */*
No content
Deletes multiple recordings at once. This is an asynchronous operation. The endpoint returns immediately, and schedules a background job to delete the recordings. The endpoint is idempotent, meaning it will return the same response even if the recordings have already been deleted, or the recordings doesn't exist.
The recording ID to delete.
a56f6ad7-37fe-4a37-9319-3174630ba57aPOST /v1/recordings/bulk-delete HTTP/1.1
Host: api.whereby.dev
Content-Type: application/json
Accept: */*
Content-Length: 57
{
"recordingIds": [
"a56f6ad7-37fe-4a37-9319-3174630ba57a"
]
}No content