Fetch all recordings for an App
realtime_kit.recordings.get_recordings(strapp_id, RecordingGetRecordingsParams**kwargs) -> RecordingGetRecordingsResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/recordings
Returns all recordings for an App. If the meeting_id parameter is passed, returns all recordings for the given meeting ID.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
Accepted Permissions (at least one required)
Parameters
end_time: Optional[Union[str, datetime]]
The end time range for which you want to retrieve the meetings. The time must be specified in ISO format.
formatdate-time
meeting_id: Optional[str]
ID of a meeting. Optional. Will limit results to only this meeting if passed.
formatuuid
page_no: Optional[float]
The page number from which you want your page search results to be displayed.
minimum0
Fetch all recordings for an App
import os
from cloudflare import Cloudflare
client = Cloudflare(
api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted
)
response = client.realtime_kit.recordings.get_recordings(
app_id="app_id",
account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(response.data){
"data": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"audio_download_url": "https://example.com",
"download_url": "https://example.com",
"download_url_expiry": "2019-12-27T18:11:19.117Z",
"file_size": 0,
"invoked_time": "2019-12-27T18:11:19.117Z",
"output_file_name": "output_file_name",
"session_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"started_time": "2019-12-27T18:11:19.117Z",
"status": "INVOKED",
"stopped_time": "2019-12-27T18:11:19.117Z",
"meeting": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"created_at": "2019-12-27T18:11:19.117Z",
"updated_at": "2019-12-27T18:11:19.117Z",
"live_stream_on_start": true,
"persist_chat": true,
"record_on_start": true,
"recording_config": {
"audio_config": {
"channel": "mono",
"codec": "MP3",
"export_file": true
},
"file_name_prefix": "file_name_prefix",
"live_streaming_config": {
"rtmp_url": "rtmp://a.rtmp.youtube.com/live2"
},
"max_seconds": 60,
"realtimekit_bucket_config": {
"enabled": true
},
"storage_config": {
"type": "aws",
"auth_method": "KEY",
"bucket": "bucket",
"host": "host",
"password": "password",
"path": "path",
"port": 0,
"private_key": "private_key",
"region": "us-east-1",
"secret": "secret",
"username": "username"
},
"video_config": {
"codec": "H264",
"export_file": true,
"height": 720,
"watermark": {
"position": "left top",
"size": {
"height": 1,
"width": 1
},
"url": "https://example.com"
},
"width": 1280
}
},
"session_keep_alive_time_in_secs": 60,
"status": "ACTIVE",
"summarize_on_end": true,
"title": "title",
"transcribe_on_end": true
},
"recording_duration": 0,
"storage_config": {
"type": "aws",
"auth_method": "KEY",
"bucket": "bucket",
"host": "host",
"password": "password",
"path": "path",
"port": 0,
"private_key": "private_key",
"region": "us-east-1",
"secret": "secret",
"username": "username"
}
}
],
"paging": {
"end_offset": 30,
"start_offset": 1,
"total_count": 30
},
"success": true
}Returns Examples
{
"data": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"audio_download_url": "https://example.com",
"download_url": "https://example.com",
"download_url_expiry": "2019-12-27T18:11:19.117Z",
"file_size": 0,
"invoked_time": "2019-12-27T18:11:19.117Z",
"output_file_name": "output_file_name",
"session_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"started_time": "2019-12-27T18:11:19.117Z",
"status": "INVOKED",
"stopped_time": "2019-12-27T18:11:19.117Z",
"meeting": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"created_at": "2019-12-27T18:11:19.117Z",
"updated_at": "2019-12-27T18:11:19.117Z",
"live_stream_on_start": true,
"persist_chat": true,
"record_on_start": true,
"recording_config": {
"audio_config": {
"channel": "mono",
"codec": "MP3",
"export_file": true
},
"file_name_prefix": "file_name_prefix",
"live_streaming_config": {
"rtmp_url": "rtmp://a.rtmp.youtube.com/live2"
},
"max_seconds": 60,
"realtimekit_bucket_config": {
"enabled": true
},
"storage_config": {
"type": "aws",
"auth_method": "KEY",
"bucket": "bucket",
"host": "host",
"password": "password",
"path": "path",
"port": 0,
"private_key": "private_key",
"region": "us-east-1",
"secret": "secret",
"username": "username"
},
"video_config": {
"codec": "H264",
"export_file": true,
"height": 720,
"watermark": {
"position": "left top",
"size": {
"height": 1,
"width": 1
},
"url": "https://example.com"
},
"width": 1280
}
},
"session_keep_alive_time_in_secs": 60,
"status": "ACTIVE",
"summarize_on_end": true,
"title": "title",
"transcribe_on_end": true
},
"recording_duration": 0,
"storage_config": {
"type": "aws",
"auth_method": "KEY",
"bucket": "bucket",
"host": "host",
"password": "password",
"path": "path",
"port": 0,
"private_key": "private_key",
"region": "us-east-1",
"secret": "secret",
"username": "username"
}
}
],
"paging": {
"end_offset": 30,
"start_offset": 1,
"total_count": 30
},
"success": true
}