List recordings of an account

List Cloud Recordings available on an Account.

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

Prerequisites:

A Pro or a higher paid plan with Cloud Recording option enabled.
Scopes: recording:read:admin or account:read:admin

If the scope recording:read:admin is used, the Account ID of the Account must be provided in the accountId path parameter to list recordings that belong to the Account. This scope only works for sub accounts.

To list recordings of a master account, the scope must be account:read:admin and the value of accountId should be me.
Rate Limit Label: Medium

{ "from": "2019-08-19", "meetings": [ { "account_id": "lq8QK_AAAAAAAAA", "duration": 2, "host_email": "thehostemail@somemail.com", "host_id": "uLoABCDEF_qQGIsQ", "id": 101010101, "recording_count": 3, "recording_files": [ { "download_url": "https://zoom.us/recording/download/abcdEFgkkkkk", "file_size": 26966, "file_type": "M4A", "id": "2f6bbbb-0fd7-4691-af13-aaaaaa", "meeting_id": "i9zq0MR8S/abcdef==", "play_url": "https://zoomdev.us/recording/play/abcdEFgkkkkk", "recording_end": "2019-08-20T00:53:16Z", "recording_start": "2019-08-20T00:51:54Z", "recording_type": "audio_only", "status": "completed" }, { "download_url": "https://zoom.us/recording/download/JolGd4kUpBEo44Q31BVEXrGeCdbT4-MOAAAAA", "file_size": 37, "file_type": "CHAT", "id": "39362666-0fd7-4691-af13-aaaaaa", "meeting_id": "i9zq0MR8S/abcdef==", "play_url": "https://zoom.us/recording/play/UpBEo44Q31BVEXrGeCdbT4-MOAAAAAAA", "recording_end": "2019-08-20T00:53:16Z", "recording_start": "2019-08-20T00:51:54Z", "recording_type": "chat_file", "status": "completed" }, { "download_url": "https://zoom.us/recording/download/5Y2YnU-56ZY4lEA5AAAABBBBBCCCCCDDDDD", "file_size": 101679, "file_type": "MP4", "id": "K809nk-014djkfsgf-00a98c13ec783", "meeting_id": "i9zq0MR8S/abcdef==", "play_url": "https://zoom.us/recording/play/5Y2YnU-56ZY4lEA5AAAABBBBBCCCCCDDDDD", "recording_end": "2019-08-20T00:53:16Z", "recording_start": "2019-08-20T00:51:54Z", "recording_type": "shared_screen_with_speaker_view", "status": "completed" } ], "share_url": "https://zoom.us/recording/share/SBDDBJKsbjdAAAAA", "start_time": "2019-08-20T00:52:13Z", "timezone": "America/Los_Angeles", "topic": "MyTestMeeting", "total_size": 128682, "type": 2, "uuid": "i9zq0MR8S/abcdef==" } ], "next_page_token": "", "page_size": 30, "to": "2019-08-20" }

请求参数

Path 参数

accountId

string

必需

Unique identifier of the account.

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.

from

string <date-time>

可选

The start date in UTC for the monthly 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”.

string <date-time>

可选

The end date for the monthly range for which you would like to retrieve recordings. The maximum range can be a month.

返回响应

🟢200**Response Error Code:** `200` <br> Only available for Paid account. **HTTP Status Code:** `200` <br> Recording(s) listed successfully.

application/json

Body

from

string <date-time>

可选

The start date for the monthly 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”.

meetings

array [object {9}]

可选

Meetings Object

duration

integer

可选

The scheduled duration of the meeting.

host_id

string

可选

User ID of the user who is set as the host of the meeting.

string

可选

Meeting ID - Unique Identifier of a meeting, also known as Meeting Number.

recording_count

integer

可选

The total number of recordings retrieved from the account.

recording_files

array [object {10}]

可选

Recording files object

start_time

string <date-time>

可选

The date and time at which the meeting started.

topic

string

可选

Meeting topic.

total_size

integer

可选

The total size of the meeting in bytes.

uuid

string

可选

Universally Unique Identifier of a meeting instance. Each meeting instance will have its own meeting UUID.

next_page_token

string

可选

page_size

integer

可选

The number of records returned within a single API call.

string <date-time>

可选

The end date for the monthly range for which you would like to retrieve recordings. The maximum range can be a month.

total_records

integer

可选

Total number of records found for this request across all pages.

🟠404**HTTP Status Code:** `400` <br> Account not found. **Response Error Code:** `2001`<br> This account does not exist or does not belong to you: {accountId}.