/recordings

Get recordings

Returns the recordings.

GEThttps://api.whereby.dev/v1/recordings

Query parameters

Response

200401404429

A JSON object with the page containing the array with the recordings results.

Body

application/json

results*array of Recording (object)

cursor*string

The cursor for paginating through the results. To fetch the next page, set the cursor to the cursor returned by the previous request. If there are no more results, the value returned is null.

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/recordings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200429

{
  "results": [
    {
      "recordingId": "1",
      "roomSessionId": "1",
      "filename": "recording.mp4",
      "startDate": "2020-01-01T00:00:00.000Z",
      "endDate": "2020-01-01T00:00:00.000Z",
      "sizeInMegaBytes": 100
    }
  ],
  "cursor": "text"
}

Get recording

Returns the specified recording metadata.

GEThttps://api.whereby.dev/v1/recordings/{recordingId}

Path parameters

recordingId*any

Recording ID.

Example: "1"

Response

200401404429

A JSON object representing the recording.

Body

application/json

Recording (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/recordings/{recordingId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200429

{
  "recordingId": "1",
  "roomSessionId": "1",
  "filename": "recording.mp4",
  "startDate": "2020-01-01T00:00:00.000Z",
  "endDate": "2020-01-01T00:00:00.000Z",
  "sizeInMegaBytes": 100
}

Get recording access link

Returns the access link for the specified recording.

GEThttps://api.whereby.dev/v1/recordings/{recordingId}/access-link

Path parameters

recordingId*any

Recording ID.

Example: "1"

Query parameters

Response

200401404429

A JSON object representing the access link.

Body

application/json

accessLink*string

The access link.

Example: "https://s3.eu-central-1.amazonaws.com/recordings/1.mp4?AWSAccessKeyId=AKIAJ..."

expires*integer

The timestamp when the access link expires.

Example: 1588262400000

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/recordings/{recordingId}/access-link', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200429

{
  "accessLink": "https://s3.eu-central-1.amazonaws.com/recordings/1.mp4?AWSAccessKeyId=AKIAJ...",
  "expires": 1588262400000
}

Bulk delete recordings

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.

POSThttps://api.whereby.dev/v1/recordings/bulk-delete

Body

application/json

recordingIds*array of string

Response

204401429

The resources are scheduled for deletion.

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/recordings/bulk-delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "recordingIds": [
        "1"
      ]
    }),
});
const data = await response.json();

Response

429

{
  "error": "Rate limit active for throttle key: organization:1",
  "data": {
    "msLeft": 38689
  }
}

Delete recording

Deletes the specified recording. The endpoint is idempotent, meaning it will return the same response even if the recording has already been deleted.

DELETEhttps://api.whereby.dev/v1/recordings/{recordingId}

Path parameters

recordingId*any

Recording ID.

Example: "1"

Response

204401429

The resource was deleted successfully.

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/recordings/{recordingId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

429

{
  "error": "Rate limit active for throttle key: organization:1",
  "data": {
    "msLeft": 38689
  }
}