Fetch Recordings
Endpoint: /recording/fetch
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| room_ids | array | Yes | Array of room IDs to fetch recordings for. |
| from | number | No | Starting index for records. Default is 0. |
| limit | number | No | Maximum number of records to return. Default is 20. |
| order_by | string | No | Sort order: DESC or ASC. Default is DESC. |
Example Request:
{
"room_ids": ["room01"],
"from": 0,
"limit": 20,
"order_by": "DESC"
}
Response
| Field | Type | Position | Description |
|---|---|---|---|
| status | boolean | root | Indicates if the request was successful. |
| msg | string | root | Response message. |
| result | object | root | Contains the recordings data. |
Result
| Field | Type | Description |
|---|---|---|
| total_recordings | number | Total number of recordings found. |
| from | number | Starting index for the returned records. |
| limit | number | Number of records returned. |
| order_by | string | Sort order used for the records. |
| recordings_list | Array<Recording Info> | List of recording records. |
Recording Info
| Field | Type | Description |
|---|---|---|
| record_id | string | Unique identifier for the recording. |
| room_id | string | ID of the room associated with the recording. |
| room_sid | string | SID of the room. |
| file_path | string | Path to the recording file. |
| file_size | number | Size of the recording file in bytes. |
| creation_time | number | Recording creation time (Unix timestamp). |
| room_creation_time | number | Room creation time (Unix timestamp). |
| metadata | RecordingMetadata | Metadata associated with the recording. |
RecordingMetadata Object
| Field | Type | Description |
|---|---|---|
| title | string | The title of the recording. |
| description | string | The description of the recording. |
| subtitles | map RecordingSubtitle | A map of language codes to subtitle objects. e.g. {"en": {"url": "..."}} |
| extra_data | map | A map of extra data stored with the recording. e.g. {"key": "value"} |
RecordingSubtitle Object
| Field | Type | Description |
|---|---|---|
| label | string | The label for the subtitle. |
| url | string | The URL of the subtitle file. |