Logo
Zoom Public API Documentation

List session's recordings

GET {{baseUrl}}/videosdk/sessions/:sessionId/recordings?include_fields=download_access_token&ttl=0

Get all the [recordings] from a session instance. The recording files can be downloaded via the download_url property listed in the response.

To access a password-protected cloud recording, add an access_token parameter to the download URL and provide JWT as the access_token value.

Rate Limit Label: Light

 

Body PARAM

Key Datatype Required Description 
include_fields
string Get the `download_access_token` field for downloading session recordings.
ttl
number Time to live (TTL) of the `download_access_token`. This is only valid if the `include_fields` query parameter contains `download_access_token`. The range is between 0-604800.



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "session_id": "KkMHZ4y8QhSUWAHi5sWvfg==", "session_name": "session name", "start_time": "2022-03-10T02:27:24Z", "duration": 2, "total_size": 444601, "recording_count": 4, "recording_files": [ { "id": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "session_id": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "recording_start": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "recording_end": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "file_type": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "file_size": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "download_url": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "status": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "deleted_time": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "recording_type": { "value": "<Error: Too many levels of nesting to fake this schema>" } }, { "id": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "session_id": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "recording_start": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "recording_end": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "file_type": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "file_size": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "download_url": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "status": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "deleted_time": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "recording_type": { "value": "<Error: Too many levels of nesting to fake this schema>" } } ], "download_access_token": "exampleTokenXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "password": "123456", "participant_audio_files": [ { "id": "24698bd1-589e-4c33-9ba3-bc788b2a0ac2", "recording_start": "2021-12-07T05:40:28Z", "recording_end": "2021-12-07T05:42:28Z", "file_name": "file name", "file_type": "MP4", "file_extension": "MP4", "file_size": 352121, "download_url": "https://download/example/download_url", "status": "completed" }, { "id": "24698bd1-589e-4c33-9ba3-bc788b2a0ac2", "recording_start": "2021-12-07T05:40:28Z", "recording_end": "2021-12-07T05:42:28Z", "file_name": "file name", "file_type": "MP4", "file_extension": "MP4", "file_size": 352121, "download_url": "https://download/example/download_url", "status": "completed" } ] }



Curl
curl -X GET 'https://api.zoom.us/v2/videosdk/sessions/:sessionId/recordings?include_fields=download_access_token&ttl=0?include_fields=download_access_token&ttl=0' -H 'Accept: application/json'

ENDPOINTS