获取会议报告

检索报告在指定时间段内的过去会议和网络研讨会。报告的时间范围限制为一个月，并且该月必须在过去六个月内。

只有当会议和网络研讨会有两个或多个独特的参与者时，才会返回会议和网络研讨会。

** 先决条件: **

Pro或更高的计划。

** 范围: ** '报告: master'

** [速率限制标签](https://marketplace.zoom.us/docs/api参考/速率限制 # 速率限制):** “沉重”

请求参数

Path 参数

userId

string

必需

用户的用户ID或电子邮件地址。对于用户级应用，传递 “我” 值。

accountId

string

帐户的唯一标识符。

必需

Query 参数

from

string

必需

以 'yyyy-mm-d' 格式的开始日期。“从” 和 “到” 参数定义的日期范围应该只有一个月，因为报告一次只包括一个月的数据。

string

结束日期。

必需

page_size

integer

可选

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

next_page_token

string

可选

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

type

string

可选

要查询的会议类型:

“过去”-所有过去的会议。

'pastOne'-单个过去的用户会议。

“已加入”-帐户用户托管或加入的所有过去的会议。

返回响应

🟢200** HTTP状态代码: ** '200' 返回活动或非活动主机报告。

application/json

Body

分页对象。

page_number

integer

已废弃

** 已弃用。** 在将来的版本中，我们将不再支持此字段。相反，使用 'next_page_token' 进行分页。

默认值:

示例值:

next_page_token

string

可选

下一页标记用于通过大型结果集进行分页。每当可用结果集超过当前页面大小时，将返回下一页令牌。此令牌的有效期为15分钟。

示例值:

w7587w4eiyfsudgk

total_records

integer

可选

跨页可用的所有记录的总数。

示例值:

from

string <date>

报告的开始日期。

可选

示例值:

2020-07-14

meetings

array [object {25}]

有关会议的信息。

可选

has_chat

boolean

可选

指示会议中是否使用了聊天功能。

示例值:

false

user_name

string

用户的显示名称。

可选

示例值:

Jill Chill

custom_keys

array [object {2}]

可选

有关会议分配的自定义键和值的信息。这将返回最多10个项目。

<= 10 items

source

string

可选

无论是直接通过Zoom还是通过API请求创建会议:

如果会议是通过OAuth应用程序创建的，则此字段返回OAuth应用程序的名称。

如果会议是通过JWT或Zoom Web门户创建的，则返回 “Zoom” 值。

示例值:

Zoom

type

enum<integer>

可选

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

会议:

'1'-即时会议。

'2'-预定的会议。

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

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

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

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

网络研讨会:

'5'-网络研讨会。

'6'-没有固定时间的经常性网络研讨会

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

枚举值:

123456789

示例值:

has_recording

boolean

可选

指示会议中是否使用了录制功能。

示例值:

false

uuid

string

可选

会议的通用唯一标识符 (UUID)。每个会议实例都会生成一个会议UUID。

示例值:

4444AAAiAAAAAiAiAiiAii==

join_time

string

可选

与会者加入会议的日期和时间。

示例值:

12/22/2021 16:20

duration

integer

会议的持续时间。

可选

示例值:

session_key

string

可选

视频SDK自定义会话ID。

示例值:

ABC36jaBI145

integer

可选

会议ID。

示例值:

12345

meeting_encryption_status

enum<integer>

可选

会议的加密状态。

'1'-E2E加密。

'2'-增强加密。

枚举值:

示例值:

participants_count_my_account

integer

可选

我的帐户中的会议参与者数。

示例值:

host_organization

string

可选

主机组织的主机帐户名称。

示例值:

org

user_email

string <email>

可选

用户的电子邮件地址。

示例值:

jchill@example.com

leave_time

string

可选

与会者离开会议的日期和时间。

示例值:

12/22/2021 17:13

participants_count

integer

会议参与者的数量。

可选

示例值:

total_minutes

integer

可选

会议中所有会议参与者的会议纪要的总和。

示例值:

end_time

string <date-time>

可选

会议的结束日期和时间。

示例值:

2020-07-15T23:30:19Z

has_screen_share

boolean

可选

指示会议中是否使用了screenshare功能。

示例值:

false

start_time

string <date-time>

可选

会议的开始日期和时间。

示例值:

2019-07-15T23:24:52Z

schedule_time

string

可选

会议的预定日期和时间。

示例值:

12/22/2021 16:20

join_waiting_room_time

string

可选

与会者加入等候室的日期和时间。

示例值:

02/11/2022 16:15

topic

string

会议的主题。

可选

示例值:

My Meeting

host_name

string

主持人的名字。

可选

示例值:

Jill

string <date>

报告的结束日期。

可选

示例值:

2020-08-14

page_count

integer

可选

为发出的请求返回的页数。

示例值:

page_size

integer

可选

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

<= 300

默认值:

示例值:

示例

{
    "page_number": 1,
    "next_page_token": "w7587w4eiyfsudgk",
    "total_records": 20,
    "from": "2020-07-14",
    "meetings": [
        {
            "has_chat": false,
            "user_name": "Jill Chill",
            "custom_keys": [
                {
                    "value": "US",
                    "key": "Host Nation"
                }
            ],
            "source": "Zoom",
            "type": 1,
            "has_recording": false,
            "uuid": "4444AAAiAAAAAiAiAiiAii==",
            "join_time": "12/22/2021 16:20",
            "duration": 6,
            "session_key": "ABC36jaBI145",
            "id": 12345,
            "meeting_encryption_status": 1,
            "participants_count_my_account": 2,
            "host_organization": "org",
            "user_email": "jchill@example.com",
            "leave_time": "12/22/2021 17:13",
            "participants_count": 2,
            "total_minutes": 11,
            "end_time": "2020-07-15T23:30:19Z",
            "has_screen_share": false,
            "start_time": "2019-07-15T23:24:52Z",
            "schedule_time": "12/22/2021 16:20",
            "join_waiting_room_time": "02/11/2022 16:15",
            "topic": "My Meeting",
            "host_name": "Jill"
        }
    ],
    "to": "2020-08-14",
    "page_count": 1,
    "page_size": 30
}

🟠400** HTTP状态代码: ** '400' 错误的请求 ** 错误代码: ** '200' 这仅适用于付费帐户:{accountId}。 ** 错误代码: ** '300' 下一页令牌无效或已过期。 ** 错误代码: ** '200' 没有权限。

🟠404** HTTP状态代码: ** '404' 未找到 ** 错误代码: ** '1001' 用户 {userId} 不存在或不属于此帐户。

请求参数

示例代码

返回响应