获取会议参与者报告

GET

/accounts/{accountId}/report/meetings/{meetingId}/participants

返回过去有两个或更多参与者 (包括主持人) 的会议的报告。要返回只有 ** 一名 ** 参与者的过去会议的报告，使用 [** 列出会议参与者 **](/docs/api-reference/zoom-api/ma # operation/dashboardmeetingpartners) api。

** 注: **

当帐户调用此API时，此API可能会为参与者的 “user_name” 、 “ip_address” 、 “location” 和 “email” 响应返回空值:

没有 ** 签署的HIPAA商业伙伴协议 (BAA)。

是 ** legacy ** HIPAA BAA帐户。

** 先决条件: **

专业人士或更高的计划。

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

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

请求参数

Path 参数

meetingId

string

必需

会议的ID或通用唯一ID (UUID)。

如果您提供会议ID，API将返回最新会议实例的响应。

如果您提供的会议UUID以 “/” 字符开头或包含 “//” 字符，则在发出API请求之前，必须 ** 对会议UUID进行双编码。

accountId

string

帐户的唯一标识符。

必需

Query 参数

page_size

integer

可选

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

next_page_token

string

可选

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

include_fields

string

可选

如果您希望在此API调用的响应中看到注册人ID属性，请提供 'registrant_id' 作为此字段的值。注册人ID是 [会议注册人] 的唯一标识符 (/docs/api-reference/zoom-api/方法 # 操作/会议注册人)。

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200** HTTP状态代码: ** '200' 会议参与者报告已返回。仅适用于付费或ZMP帐户: {accountId}。

application/json

Body

分页对象。

next_page_token

string

可选

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

示例值:

Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3

total_records

integer

可选

跨页可用的所有记录数。

示例值:

page_count

integer

可选

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

示例值:

page_size

integer

可选

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

<= 300

默认值:

示例值:

participants

array [object {13}]

可选

会议参与者对象的数组。

leave_time

string <date-time>

参与者离开时间。

可选

示例值:

2022-03-23T07:02:28Z

user_email

string

可选

参与者电子邮件。

如果参与者不是 ** 主机帐户的一部分，则返回一个空字符串值，但有一些例外。有关详细信息，请参阅 [电子邮件地址显示规则](/docs/api-reference/using-zoom-api # 电子邮件地址)。如果调用API的账号是BAA账号，则返回空字符串值。

示例值:

jchill@example.com

registrant_id

string

可选

注册人的唯一标识符。仅当您输入 “registrant_id” 作为 “include_fields” 查询参数的值时，才返回此字段。

示例值:

abcdefghij0-klmnopq23456

participant_user_id

string

可选

参与者的通用唯一ID (UUID)。

如果参与者通过登录Zoom加入会议，此值是 [** 获取用户 **](/docs/api-reference/zoom-api/methss # operation/user) api响应中的 “id” 值。

如果参与者加入会议 ** 而没有 ** 登录Zoom，则返回空字符串值。

示例值:

DYHrdpjrS3uaOf7dPkkg8w

join_time

string <date-time>

参与者加入时间。

可选

示例值:

2022-03-23T06:58:09Z

duration

integer

参与者持续时间。

可选

示例值:

259

customer_key

string

可选

参与者的SDK标识符。此值可以是字母数字，最大长度为35个字符。

<= 35 字符

示例值:

349589LkJyeW

bo_mtg_id

string

可选

分组会议室 ID。每个分组会议室都被分配了一个唯一的ID。

示例值:

27423744

failover

boolean

可选

指示在会议期间是否发生故障转移。

示例值:

false

user_id

string

可选

参与者ID。这是分配给参加会议的参与者的唯一ID，并且仅对该会议有效。

示例值:

27423744

name

string

可选

参与者显示名称。

如果调用API的账号是BAA账号，则返回空字符串值。

示例值:

example

string

可选

参与者的通用唯一ID (UUID)。

如果参与者通过登录Zoom加入会议，此值是 [** 获取用户 **](/docs/api-reference/zoom-api/methss # operation/user) api响应中的 “id” 值。

如果参与者加入会议 ** 而没有 ** 登录Zoom，则返回空字符串值。

** 注意: ** 使用 'participant_user_id' 值而不是此值。我们将在将来的版本中删除此响应。

示例值:

30R7kT7bTIKSNUFEuH_Qlg

status

enum<string>

可选

参与者的状态。

'in_meeting'-在会议中。

“in_waiting_room”-在等候室。

枚举值:

in_meetingin_waiting_room

示例值:

in_meeting

示例

{
    "next_page_token": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
    "total_records": 1,
    "page_count": 1,
    "page_size": 30,
    "participants": [
        {
            "leave_time": "2022-03-23T07:02:28Z",
            "user_email": "jchill@example.com",
            "registrant_id": "abcdefghij0-klmnopq23456",
            "participant_user_id": "DYHrdpjrS3uaOf7dPkkg8w",
            "join_time": "2022-03-23T06:58:09Z",
            "duration": 259,
            "customer_key": "349589LkJyeW",
            "bo_mtg_id": "27423744",
            "failover": false,
            "user_id": "27423744",
            "name": "example",
            "id": "30R7kT7bTIKSNUFEuH_Qlg",
            "status": "in_meeting"
        }
    ]
}

🟠400** HTTP状态代码: ** '400' 错误的请求 ** 错误代码: ** '1010' 用户不属于此帐户:{accountId}。 ** 错误码: ** '12702' 无法访问一年前的会议。 ** 错误代码: ** '200' 没有权限。

🟠404** HTTP状态代码: ** '404' 未找到 ** 错误代码: ** '3001' 会议 {MeetingId} 未找到或已过期。

修改于 2023-10-31 06:13:33

获取登录/注销活动报告

获取会议报告