List archived files

GET

/archive_files

Cloud Recording

Zoom’s archiving solution allows account administrators to set up an automated mechanism to record, collect and archive meeting data to a 3rd party platform of their choice and hence, satisfy FINRA and/ or other compliance requirements.

Use this API to retrieve archived meeting or webinar files of an account.

Scope: recording:read:admin
Rate Limit Label: Medium

Prerequisites:

Enable cloud recording.

Follow the enablement process to access the archiving feature.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/archive_files'

响应示例

200 - response

{
  "from": "2021-03-11T05:41:36Z",
  "meetings": [
    {
      "archive_files": [
        {
          "download_url": "https://zoom.us/rec/archive/download/snGardfsw3435SKIsXAMhJ6wh",
          "file_extension": "M4A",
          "file_size": 165743,
          "file_type": "M4A",
          "id": "55hfgsd-sd8e2bd7255",
          "recording_type": "audio_only",
          "status": "completed"
        },
        {
          "download_url": "https://zoom.us/rec/archive/download/eXy782Ua9dghjhPvao.bUFwLAgQrFOjfOjr",
          "file_extension": "MP4",
          "file_size": 198720,
          "file_type": "MP4",
          "id": "9c5daa5b-34a1-40e8-8947-a11be5e373a7",
          "recording_type": "shared_screen_with_speaker_view",
          "status": "completed"
        }
      ],
      "duration": 3,
      "host_id": "Dhjdfgdkg8w",
      "id": 553068284,
      "recording_count": 2,
      "start_time": "2021-03-12T01:57:27Z",
      "timezone": "",
      "topic": "Zoom Meeting",
      "total_size": 364463,
      "type": 1,
      "uuid": "yO3dfhh3t467UkQ=="
    }
  ],
  "next_page_token": "",
  "page_size": 30,
  "to": "2021-03-18T05:41:36Z"
}

请求参数

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

可选

Start date for the query in "yyyy-MM-dd'T'HH:mm:ss'Z'" format. The duration for the query defined using the "from" and "to" parameters should not exceed 7 days as this API only provides a week's data at once.

string

可选

End date for the query in "yyyy-MM-dd'T'HH:mm:ss'Z'" format.

query_data_type

enum<string>

可选

Query data type for from and to.

枚举值:

meeting_start_timearchive_complete_time

默认值:

meeting_start_time

返回响应

🟢200**HTTP Status Code:** `200` **OK** Archived files returned.

application/json

Body

from

string

可选

meetings

array [object {11}]

可选

archive_files

array [object {7}]

可选

duration

integer

可选

Scheduled duration of the meeting or the webinar.

host_id

string

可选

ID of the user set as the host of meeting or the webinar that was archived.

integer

可选

Unique identifier of the meeting(meetingId) or the webinar(webinarId).

recording_count

integer

可选

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

start_time

string

可选

The time at which the meeting or the webinar started.

timezone

string

可选

Timezone of the host.

topic

string

可选

Meeting or webinar topic.

total_size

integer

可选

Total size of the archive.

type

integer

可选

Type of the meeting or the webinar that was archived.

Meeting types:
1 - Instant meeting
2 - Scheduled meeting
3 - Recurring meeting with no fixed time

8 - Recurring meeting with fixed time

Webinar types:
5 - Webinar
6 - Recurring webinar with no fixed time
9 - Recurring webinar with a fixed time

uuid

string

可选

Unique identifier of the meeting instance or the webinar instance during which the archiving took place. Each instance of the meeting will have its own UUID.

next_page_token

string

可选

page_size

integer

可选

The number of records returned within a single API call.

string

可选

End date for the query in "yyyy-MM-dd'T'HH:mm:ss'Z'" format.

🟠400**HTTP Status Code:** `400` **Bad request**<br> **Error Code:** `2001`<br> Account does not exist: {accountId}.

修改于 2024-04-24 09:06:48

List recordings of an account

Delete meeting recordings