列出已存档的文件

获取帐户的存档会议或网络研讨会文件。

Zoom的存档解决方案允许帐户管理员设置自动化机制来记录、收集、并将会议数据存档到他们选择的第三方平台，以满足FINRA或其他合规性要求。

** 先决条件: **

** 会议和网络研讨会存档 ** 功能通过 Zoom Support 为您的帐户启用。

** 范围: ** '录音: master'

** [速率限制标签](https://marketplace.zoom.us/docs/api-reference/Rate-limits # 速率限制):** 'MEDIUM'

请求参数

Path 参数

accountId

string

帐户的唯一标识符。

必需

Query 参数

page_size

integer

可选

单个API调用中返回的记录数。

next_page_token

string

可选

使用next page标记对大型结果集进行分页。只要可用结果集超过当前页面大小时，就会返回下一页令牌。此令牌的有效期为15分钟。

from

string

可选

查询开始日期，格式为 'yyyy-mm-dd 't'hh: MM: ssZ'。此值和 “到” 查询参数值不能超过7天。

string

可选

查询结束日期，格式为 'yyyy-mm-dd 't'hh: MM: ssZ'。此值和 “from” 查询参数值不能超过7天。

query_date_type

string

可选

查询日期的类型。

'meeting_start_time'

'archive_complete_time'

此值默认为 'meeting_start_time'。

返回响应

🟢200** HTTP状态代码: ** '200' 已存档的文件已返回。

application/json

Body

next_page_token

string

可选

使用next page标记对大型结果集进行分页。只要可用结果集超过当前页面大小时，就会返回下一页令牌。此令牌的有效期为15分钟。

** 注意: ** 如果使用 'next_page_token' 作为参数，则其他请求参数应保持不变，以确保大型结果集是您想要的。例如，如果您的 'to' 参数是未来时间，Zoom会将此值重置为当前时间，并在响应正文中返回此值以及 'next_page_token' 值。在剩余结果集的请求中使用这些相同的 “to” 和 “next_page_token” 值; 否则您将收到无效的令牌错误。

示例值:

At6eWnFZ1FB3arCXnRxqHLXKhbDW18yz2i2

total_records

integer

可选

返回的会议记录的总数。

示例值:

from

string <date-time>

查询的开始日期。

可选

示例值:

2021-03-12T02:12:27Z

meetings

array [object {18}]

可选

有关会议或网络研讨会的信息。

timezone

string

必需

会议或网络研讨会的 [时区](https://developers.zoom.us/docs/api/rest/其他-参考/缩写-列表/# 时区)。

示例值:

Asia/Shanghai

total_size

integer

必需

存档文件的总大小 (以字节为单位)。

示例值:

364463

meeting_type

enum<string>

必需

无论会议或网络研讨会是内部的还是外部的。

“内部”-内部会议或网络研讨会。

“外部”-外部会议或网络研讨会。

当该值为 “外部” 时，删除该响应中的 “id” 、 “host_id” 和 “topic'pii (个人身份信息) 值。

枚举值:

internalexternal

示例值:

internal

recording_count

integer

必需

API调用响应中返回的已存档文件的数量。

示例值:

is_breakout_room

boolean

必需

房间是否为分组会议室。

示例值:

false

type

enum<integer>

必需

存档会议或网络研讨会的类型。

会议录制使用这些存档类型。

'1'-即时会议。

'2'-预定的会议。

'3'-没有固定时间的定期会议。

'4'-通过PMI (个人会议ID) 创建的会议。

'7' - A 个人音频会议 (PAC)。

'8'-固定时间的定期会议。

网络研讨会录制使用这些存档类型。

'5'-网络研讨会。

'6'-没有固定时间的定期网络研讨会。

'9'-固定时间的定期网络研讨会。

如果录音 ** 不是 ** 来自会议或网络研讨会:

'100' - A 分组会议室。

枚举值:

123456789100

示例值:

uuid

string

必需

录制的会议或网络研讨会实例的通用唯一标识符 (UUID)。每个会议或网络研讨会实例都会生成一个UUID。

示例值:

yO3dfhh3t467UkQ==

host_id

string

必需

设置为存档会议或网络研讨会主持人的用户的ID。

示例值:

Dhjdfgdkg8w

duration

integer

必需

会议或网络研讨会的预定持续时间。

示例值:

start_time

string <date-time>

必需

会议或网络研讨会的开始时间。

示例值:

2021-04-26T05:23:18Z

complete_time

必需

会议或网络研讨会的存档完成时间。

account_name

string

用户的帐户名。

必需

示例值:

account_01

topic

string

必需

会议或网络研讨会主题。

示例值:

My Personal Meeting Room

integer <int64>

必需

会议或网络研讨会ID，“meetingid” 或 “webinarid”。

示例值:

553068284

parent_meeting_id

string

可选

父会议的通用唯一ID (UUID)。每个会议或网络研讨会实例都会生成一个UUID。如果 “is_breakout_room” 值为 “true”，则API返回此值。

示例值:

atsXxhSEQWit9t+U02HXNQ==

duration_in_second

integer

必需

会议或网络研讨会的持续时间 (以秒为单位)。

示例值:

1800

archive_files

array [object {16}]

必需

有关存档文件的信息。

status

enum<string>

必需

存档的处理状态。

“已完成”-存档的处理已完成。

'processing'-存档正在处理。

枚举值:

completedprocessing

示例值:

completed

string <date-time>

查询的结束日期。

可选

示例值:

2021-03-12T02:12:27Z

page_size

integer

可选

单个API调用中返回的记录数。

示例值:

示例

{
    "next_page_token": "At6eWnFZ1FB3arCXnRxqHLXKhbDW18yz2i2",
    "total_records": 20,
    "from": "2021-03-12T02:12:27Z",
    "meetings": [
        {
            "timezone": "Asia/Shanghai",
            "total_size": 364463,
            "meeting_type": "internal",
            "recording_count": 2,
            "is_breakout_room": false,
            "type": 1,
            "uuid": "yO3dfhh3t467UkQ==",
            "host_id": "Dhjdfgdkg8w",
            "duration": 1,
            "start_time": "2021-04-26T05:23:18Z",
            "complete_time": "2021-03-12T02:12:27Z",
            "account_name": "account_01",
            "topic": "My Personal Meeting Room",
            "id": 553068284,
            "parent_meeting_id": "atsXxhSEQWit9t+U02HXNQ==",
            "duration_in_second": 1800,
            "archive_files": [
                {
                    "file_path": "/9090876528/path01/demo.mp4",
                    "participant_leave_time": "2021-03-12T02:12:27Z",
                    "storage_location": "US",
                    "individual": true,
                    "encryption_fingerprint": "abf85f0fe6a4db3cdd8c37e505e1dd18a34d9696170a14b5bc6395677472cf43",
                    "number_of_messages": 150,
                    "auto_delete": false,
                    "participant_join_time": "2021-03-12T02:07:27Z",
                    "file_size": 165743,
                    "file_type": "MP4",
                    "recording_type": "shared_screen_with_speaker_view",
                    "download_url": "https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB",
                    "file_extension": "JSON",
                    "id": "a2f19f96-9294-4f51-8134-6f0eea108eb2",
                    "participant_email": "jchill@example.com",
                    "status": "completed"
                }
            ],
            "status": "completed"
        }
    ],
    "to": "2021-03-12T02:12:27Z",
    "page_size": 20
}

🟠400** HTTP状态代码: ** '400' <br> 错误的请求 ** 错误代码: ** '2001' <br> 帐户不存在: {accountId} <br>

请求参数

示例代码

返回响应