Get Recordings API
The Get Recordings API provides the ability to fetch recordings that were created using the SDK. In order to use the API, you will need to obtain an API key by connecting to your wallet, Follow the steps mentioned in the API Key section.
Endpoint
https://api.huddle01.com/api/v2/sdk/recordings
Whatever recordings are created using the SDK, will be listed in the Get Recordings API, if you want to fetch the recordings for a particular session, you can pass the sessionId
as a query parameter.
otherwise, the API will return all the recordings associated with your API Key.
/recordings
Get Recordings API
The API supports a GET request with the following required parameters:
x-api-key
- Add your API Key to the headers to fetch all rooms associated with your API Key.sessionId
- The session ID for which you want to fetch the recordings, (optional).limit
- The number of recordings you want to fetch,(optional)
.cursor
- The cursor for pagination, (optional).
let config = {
method: 'get',
maxBodyLength: Infinity,
url: 'https://api.huddle01.com/api/v2/sdk/recordings?sessionId={{sessionId}}&limit=1&cursor=1',
headers: {
'x-api-key': '••••••'
}
};
axios.request(config)
sessionId
is an optional parameter. To Fetch sessionId
of a particular roomId. You can use the Get session API.
Upon success, the API will return a response with an array of rooms with the following fields:
nextCursor
- The cursor for the paginationrecordings
- The list of recordings with their respective id, url and size.
In case of an error, the API will return an error message with a corresponding status code.
{
"nextCursor": 1,
"recordings": [
{
"id": "dummy-recording-id",
"recordingUrl": "https://dummy-recording-url.com",
"recordingSize": 100
}
]
}