List all recordings

When a user records a meeting or a webinar by choosing the Record to the Cloud option, the video, audio, and chat text are recorded in the Zoom cloud.

Use this API to list all Cloud recordings of a user.

To access a user's password protected cloud recording, add an "access_token" parameter to the download URL and provide either the JWT or the user's OAuth access token as the value of the "access_token" parameter.

Scopes: recording:read:admin recording:read

Rate Limit Label: Medium
Prerequisites:

Pro or a higher plan.

Cloud Recording must be enabled on the user's account.

{ "from": "2019-08-15", "meetings": [ { "account_id": "AbcjxkfhdEEE", "duration": 1, "host_id": "z8dfkgABBBBBBBfp8uQ", "id": 1000000000000, "recording_count": 1, "recording_files": [ { "download_url": "https://api.zoom.us/recording/download/pfA2AvvvvvAnAzOibbbbELxl", "file_size": 10098, "file_type": "M4A", "id": "589ABBBBB-8718e", "meeting_id": "gkABCDEnCkPuA==", "play_url": "https://api.zoom.us/recording/play/pfA2AvvvvvAnAzOibbbbELxl", "recording_end": "2019-08-29T21:55:24Z", "recording_start": "2019-08-29T21:54:55Z", "recording_type": "audio_only", "status": "completed" }, { "download_url": "https://api.zoom.us/recording/download/cc33ekldfdjfhf3-aaaaa", "file_type": "TIMELINE", "meeting_id": "gkABCDEnCkPuA==", "recording_end": "2019-08-29T21:55:24Z", "recording_start": "2019-08-29T21:54:55Z" }, { "download_url": "https://api.zoom.us/recording/download/abcdkjfhdhfdhfj", "file_size": 37285, "file_type": "MP4", "id": "96119b=kdfhf791", "meeting_id": "gkABCDEnCkPuA==", "play_url": "https://api.zoom.us/recording/play/abcdkjfhdhfdhfj", "recording_end": "2019-08-29T21:55:24Z", "recording_start": "2019-08-29T21:54:55Z", "recording_type": "shared_screen_with_speaker_view", "status": "completed" } ], "share_url": "https://api.zoom.us/recording/share/IABCDJDKDJEEEEEk_GwfdggdgkTziMw", "start_time": "2019-08-29T21:54:49Z", "timezone": "America/Los_Angeles", "topic": "MyTestPollMeeting", "total_size": 47383, "type": 2, "uuid": "gkABCDEnCkPuA==" } ], "next_page_token": "", "page_count": 1, "page_size": 30, "to": "2019-09-15", "total_records": 1 }

请求参数

Path 参数

userId

string

必需

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

Query 参数

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

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.

string

可选

Query Metadata of Recording if an On-Premise Meeting Connector was used for the meeting.

默认值:

false

trash

boolean

可选

Query trash.
true: List recordings from trash.
false: Do not list recordings from the trash.
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.

默认值:

false

from

string <date>

可选

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.

string <date>

可选

End date in 'yyyy-mm-dd' 'yyyy-mm-dd' UTC format.

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:
meeting_recordings: List all meeting recordings from the trash.
recording_file: List all individual recording files from the trash.

默认值:

meeting_recordings

返回响应

🟢200**HTTP Status Code:** `200`<br> List of recording objects returned.

application/json

Body

List of recordings.

from

string <date>

可选

Start Date.

string <date>

End Date.

可选

next_page_token

string

可选

page_count

integer

可选

The number of pages returned for the request made.

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

total_records

integer

可选

The number of all records available across pages.

meetings

array[object (Recording file List) {11}]

Recording List

可选

List of recordings.

account_id

string

可选

Unique Identifier of the user account.

duration

integer

可选

Meeting duration.

host_id

string

可选

ID of the user set as host of meeting.

string

可选

Meeting ID - also known as the meeting number.

recording_count

string

可选

Number of recording files returned in the response of this API call.

start_time

string <date-time>

可选

The time at which the meeting started.

topic

string

可选

Meeting topic.

total_size

string

可选

Total size of the recording.

type

string

可选

Type of the meeting that was recorded.

Meeting Types:
1 - Instant meeting.
2 - Scheduled meeting.
3 - Recurring meeting with no fixed time.
8 - Recurring meeting with fixed time.

uuid

string

可选

Unique Meeting Identifier. Each instance of the meeting will have its own UUID.

recording_files

array [object {11}]

Recording file List

可选

List of recording file.

🟠404**HTTP Status Code:** `404` **Not Found**<br><br> **Error Code:** `1001`<br> User {userId} not exist or not belong to this account.