Zoom Public API Documentation
List recordings of an account
GET {{baseUrl}}/videosdk/recordings?page_size=30&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82&trash=false&trash_type=session_recordings&from=2021-10-11&to=2021-12-11
List [Video SDK Cloud Recordings] available on an Account. To access a password protected cloud recording, add an Rate Limit Label:
access_token
parameter to the download URL and provide JWT as the value of the access_token
.
Medium
Body
PARAM
| Key | Datatype | Required | Description |
page_size
|
number | The number of records returned within a single API call. | |
next_page_token
|
string | The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. | |
trash
|
boolean | Query trash. `true`: List recordings from trash.<br> `false`: Do not list recordings from the trash.<br> The default value is `false`. If you set it to `true`, you can use the `trash_type` property to indicate the type of Cloud recording that you need to retrieve. | |
trash_type
|
string | The type of Cloud recording that you would like to retrieve from the trash. The value can be one of the following:<br> `session_recordings`: List all session recordings from the trash.<br> `recording_file`: List all individual recording files from the trash. | |
from
|
string | The start date in 'yyyy-mm-dd' UTC format for the date range for which you would like to retrieve recordings. The maximum range can be a month. If no value is provided for this field, the default will be current date. For example, if you make the API request on June 30, 2020, without providing the “from” and “to” parameters, by default the value of 'from' field will be “2020-06-30” and the value of the 'to' field will be “2020-07-01”. **Note**: The "trash" files cannot be filtered by date range and thus, the "from" and "to" fields should not be used for trash files. | |
to
|
string | End date in 'yyyy-mm-dd' 'yyyy-mm-dd' UTC format. |
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": "35497738-9fef-4f8a-97db-0ec34caef065",
"session_id": "KkMHZ4y8QhSUWAHi5sWvfg==",
"recording_start": "2022-03-11T12:30:42Z",
"recording_end": "2022-03-11T12:34:42Z",
"file_type": "MP4",
"file_size": 12125,
"download_url": "https://example/download_url",
"status": "completed",
"deleted_time": "2022-03-28T07:22:22Z",
"recording_type": "audio_only"
},
{
"id": "35497738-9fef-4f8a-97db-0ec34caef065",
"session_id": "KkMHZ4y8QhSUWAHi5sWvfg==",
"recording_start": "2022-03-11T12:30:42Z",
"recording_end": "2022-03-11T12:34:42Z",
"file_type": "MP4",
"file_size": 12125,
"download_url": "https://example/download_url",
"status": "completed",
"deleted_time": "2022-03-28T07:22:22Z",
"recording_type": "audio_only"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/videosdk/recordings?page_size=30&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82&trash=false&trash_type=session_recordings&from=2021-10-11&to=2021-12-11?page_size=30&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82&trash=false&trash_type=session_recordings&from=2021-10-11&to=2021-12-11' -H 'Accept: application/json'
ENDPOINTS