获取网络研讨会参与者

GET

/accounts/{accountId}/metrics/webinars/{webinarId}/participants

从现场或过去的网络研讨会返回有关参与者的信息。

** 注: **

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

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

是 ** legacy ** HIPAA BAA帐户。

显示 ** 不属于 ** 主机帐户的任何用户 (外部用户) 的数据，除非他们满足某些条件。有关详细信息，请参阅 [电子邮件地址显示规则](/docs/api-reference/using-zoom-api # 电子邮件地址)。

** 先决条件: **

带有网络研讨会插件的业务、教育或API计划。

** 范围: ** 'dashboard_webinars:master'

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

请求参数

Path 参数

webinarId

string

必需

网络研讨会的ID或通用唯一ID (UUID)。

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

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

accountId

string

帐户的唯一标识符。

必需

Query 参数

type

string

可选

要查询的网络研讨会的类型。

'过去'-所有过去的网络研讨会。

'live'-所有实时网络研讨会。

此值默认为 “live”。

page_size

integer

可选

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

next_page_token

string

可选

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

include_fields

string

可选

要包括在查询中的其他字段。

'registrant_id'-包括网络研讨会注册人的ID。注册人ID是网络研讨会注册人的唯一ID。

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200** HTTP状态代码: ** '200' 网络研讨会参与者返回。此API仅适用于已启用仪表板功能的ZMP和企业或更高版本帐户。

application/json

Body

分页对象。

next_page_token

string

可选

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

示例值:

Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3

total_records

integer

可选

跨页可用的所有记录数。

示例值:

page_count

integer

可选

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

示例值:

page_size

integer

可选

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

<= 300

默认值:

示例值:

participants

array [object {36}]

可选

有关网络研讨会参与者的信息。

pc_name

string

参与者的PC名称。

可选

示例值:

My PC

audio_quality

enum<string>

可选

参与者的音频质量分数。

'好'-音频几乎完美无瑕，质量非常好。

'公平'-音频偶尔会出现失真，噪音和其他问题，但内容基本上是连续的。参与者可以正常交流。

“差”-音频经常有失真，噪音和其他问题，但内容基本上是连续的。参与者可以正常交流。

“坏”-声音质量极差，音频内容几乎听不见。

枚举值:

goodfairpoorbad

示例值:

good

role

enum<string>

可选

参与者的角色。

'host'-主机。

“与会者”-与会者。

'小组成员'-小组成员。

枚举值:

hostattendeepanelist

示例值:

host

registrant_id

string

可选

参与者的唯一注册人ID。仅当为 “include_fields” 查询参数传递 “registrant_id” 值时，此字段才返回。

如果 “type” 查询参数为 “live'” 值，则此字段不返回。

示例值:

_f08HhPJS82MIVLuuFaJPg

user_name

string

参与者的显示名称。

可选

示例值:

jchill

participant_user_id

string

可选

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

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

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

示例值:

DYHrdpjrS3uaOf7dPkkg8w

recording

boolean

可选

在网络研讨会期间是否使用了录制功能。

示例值:

true

share_application

boolean

可选

参与者是否选择在screenshare期间共享iPhone/iPad应用程序。

示例值:

true

join_time

string <date-time>

可选

参与者加入网络研讨会的时间。

示例值:

2022-01-13T05:27:09Z

full_data_center

string

可选

存储参与者会议数据的数据中心。此字段包括HTTP隧道 (HT) 、云机房连接器 (CRC) 和实时Web网关 (RWG) 位置信息的分号分隔列表。

示例值:

United States;China (TJ RWG);

customer_key

string

可选

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

<= 35 字符

示例值:

349589LkJyeW

mac_addr

string

可选

参与者的MAC地址。

** 注意: ** 此响应为 ** 不属于 ** 主机帐户的任何用户 (外部用户) 返回一个空字符串 ('“') 值。

示例值:

f85e-a012-92d8

string

可选

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

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

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

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

示例值:

_f08HhPJS82MIVLuuFaJPg

leave_reason

enum<string>

可选

参与者离开网络研讨会的原因，其中 “$ name” 是参与者的用户名:

'$ name已离开会议。'

'$ name已与会议断开连接。'

“主持人结束了会议。”

'主持人开始了新的会议。'

'网络连接错误。'

'主机未加入。'

'超出免费会议分钟数限制。'

'已由主机移除。'

“未知原因”。
“离开等候室。

'由主人从等候室移走。'

枚举值:

$name left the webinar.$name got disconnected from the webinar.Host ended the webinar.Host closed the webinar.Host started a new webinar.Network connection error.Host did not join.Exceeded free webinar minutes limit.Removed by host.Unknown reason.Leave waiting room.Removed by host from waiting room.

示例值:

Host ended the webinar.

microphone

string

可选

参与者在网络研讨会期间使用的麦克风类型。

** 注意: ** 此响应为 ** 不属于 ** 主机帐户的任何用户 (外部用户) 返回一个空字符串 ('“') 值。

示例值:

Plantronics BT600

string

可选

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

示例值:

jchill@example.com

leave_time

string <date-time>

可选

参与者离开网络研讨会的时间。对于实时网络研讨会，仅当参与者已离开正在进行的网络研讨会时，此字段才会返回。

示例值:

2022-01-13T05:41:01Z

connection_type

string

参与者的连接类型。

可选

示例值:

UDP

video_quality

enum<string>

可选

参与者的视频质量。

'好'-视频几乎完美无瑕，质量非常好。

'公平'-视频清晰度很高，偶尔会卡住，快或慢，或其他问题，但频率很低，视频质量很好。

'poor'-视频清晰度不高，但不存在很多问题。视频质量一般。

“坏”-图片非常模糊，经常被卡住。

枚举值:

goodfairpoorbad

示例值:

good

from_sip_uri

string

可选

会议参与者的SIP furi标头。API仅在参与者通过SIP加入会议时返回此响应。

示例值:

example.com

data_center

string

可选

参与者用来加入网络研讨会的数据中心。

示例值:

United States

ip_address

string

参与者的IP地址。

可选

示例值:

192.0.2.1

version

string

可选

参与者的Zoom客户端版本。

示例值:

5.9.1.2581

share_whiteboard

boolean

可选

参与者是否选择在屏幕共享期间共享他们的白板。

示例值:

true

user_id

string

可选

参与者的ID。此值在参加网络研讨会时分配给参与者，并且仅在网络研讨会的持续时间内有效。

示例值:

33080320

audio_call

array [object {3}]

可选

有关会议参与者的音频呼叫的信息。一些参与者可通过电话呼叫加入会议或被绑定到音频。

domain

string

可选

参与者的PC域。

** 注意: ** 对于 ** 不属于 ** 主机帐户的任何用户 (外部用户)，此响应将返回一个空字符串 ('') 值。

示例值:

example.com

internal_ip_addresses

array[string]

可选

参与者的内部IP地址。在以下情况下，此字段将不返回:

调用此API的帐户是 ** legacy ** [HIPAA下的业务伙伴协议 (BAA)](https://www.ecfr.gov/cgi-bin/retrieveECFR？gp = 1 & n = se45.1.160 _1103 & r = SECTION & ty = HTML)。

调用该API的账号是HIPAA下的BAA **，没有 ** 签名的BAA数据处理附录。

sip_uri

string

可选

会议参与者的SIP (会话发起协议) 联系报头URI。API仅在参与者通过SIP加入会议时返回此响应。

示例值:

example.com

speaker

string

可选

参与者在网络研讨会期间使用的演讲者类型。

** 注意: ** 此响应为 ** 不属于 ** 主机帐户的任何用户 (外部用户) 返回一个空字符串 ('“') 值。

示例值:

speaker (2- High Definition Audio Device)

location

string

参与者的位置。

可选

示例值:

United States

screen_share_quality

enum<string>

可选

参与者的屏幕共享质量分数。

'好'-视频几乎完美无瑕，质量非常好。

'公平'-视频清晰度很高，偶尔会卡住，快或慢，或其他问题，但频率很低，视频质量很好。

'poor'-视频清晰度不高，但不存在很多问题。视频质量一般。

“坏”-图片非常模糊，经常被卡住。

枚举值:

goodfairpoorbad

示例值:

good

harddisk_id

string

可选

参与者的硬盘ID。

** 注意: ** 对于 ** 不属于 ** 主机帐户的任何用户 (外部用户)，此响应将返回一个空字符串 ('') 值。

示例值:

Disk01

network_type

enum<string>

可选

参与者的网络类型。

“线”

'Wifi'

“Ppp”-点对点。

“蜂窝”-3g、4g和5g蜂窝。

“其他”-未知设备。

枚举值:

WiredWifiPPPCellularOthers

示例值:

Wired

device

enum<string>

可选

参与者用于加入网络研讨会的设备类型。

“电话”-参与者通过PSTN加入。

'H.323/SIP'-通过H.323或SIP设备加入的参与者。

“Windows”-参与者使用Windows设备通过VoIP加入。

'Mac '-参与者使用Mac设备通过VoIP加入。

'Ios '-参与者使用iOS设备通过VoIP加入。

'Android'-参与者使用Android设备通过VoIP加入。

** 注意: ** 对于 ** 不属于 ** 主机帐户的任何用户 (外部用户)，此响应将返回一个空字符串 ('') 值。

枚举值:

PhoneH.323/SIPWindowsMaciOSAndroid

示例值:

Phone

share_desktop

boolean

可选

参与者是否选择在screenshare期间共享其桌面。

示例值:

true

示例

{
    "next_page_token": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
    "total_records": 1,
    "page_count": 1,
    "page_size": 30,
    "participants": [
        {
            "pc_name": "My PC",
            "audio_quality": "",
            "role": "host",
            "registrant_id": "_f08HhPJS82MIVLuuFaJPg",
            "user_name": "jchill",
            "participant_user_id": "DYHrdpjrS3uaOf7dPkkg8w",
            "recording": true,
            "share_application": true,
            "join_time": "2022-01-13T05:27:09Z",
            "full_data_center": "United States;China (TJ RWG);",
            "customer_key": "349589LkJyeW",
            "mac_addr": "f85e-a012-92d8",
            "id": "_f08HhPJS82MIVLuuFaJPg",
            "leave_reason": "$name left the webinar.",
            "microphone": "Plantronics BT600",
            "email": "jchill@example.com",
            "leave_time": "2022-01-13T05:41:01Z",
            "connection_type": "UDP",
            "video_quality": "",
            "from_sip_uri": "example.com",
            "data_center": "United States",
            "ip_address": "192.0.2.1",
            "version": "5.9.1.2581",
            "share_whiteboard": true,
            "user_id": "33080320",
            "audio_call": [
                {
                    "call_number": "4131",
                    "call_type": "call-in",
                    "zoom_number": "18773690926"
                }
            ],
            "domain": "example.com",
            "internal_ip_addresses": [
                "198.51.100.1"
            ],
            "sip_uri": "example.com",
            "speaker": "speaker (2- High Definition Audio Device)",
            "location": "United States",
            "screen_share_quality": "",
            "harddisk_id": "Disk01",
            "network_type": "Wired",
            "device": "Phone",
            "share_desktop": true
        }
    ]
}

🟠400** HTTP状态代码: ** '400' 错误的请求 ** 错误码: ** '12702' 一年前无法访问网络研讨会。

🟠404** HTTP状态代码: ** '404' 未找到 ** 错误代码: ** '3001' 此网络研讨会的详细信息不可用或ID无效。

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

获取zoom会议客户反馈

获取网络研讨会共享/录制详细信息