列出网络研讨会参与者QoS

显示来自现场或过去网络研讨会的网络研讨会参与者列表，以及他们在网络研讨会期间获得的服务质量。返回的数据指示用于发送/接收视频、音频和共享内容的连接质量。

** 注: **

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

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

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

** 先决条件: **

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

** [速率限制标签](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

每页返回的项目数。

可选

next_page_token

string

可选

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

返回响应

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

application/json

Body

有关参与者及其服务质量 (QoS) 的信息。

next_page_token

string

可选

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

示例值:

y20RGLOiO2jTy3CMfnNRORmB51kAuhMy0e2

total_records

integer <int64>

可选

跨页可用的所有记录数。

示例值:

page_count

integer <int64>

可选

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

示例值:

page_size

integer

每页的项目数。

可选

<= 10

默认值:

示例值:

participants

array[object (参与者QOS) {15}]

参与者的信息。

可选

pc_name

string

参与者的PC名称。

可选

示例值:

HW0010449

leave_time

string <date-time>

可选

参与者离开会议的时间。

示例值:

2022-03-01T10:15:14Z

user_qos

array [object {21}]

可选

参与者的服务质量信息。

user_name

string

参与者的显示名称。

可选

示例值:

jchill

ip_address

string

参与者的IP地址。

可选

示例值:

192.0.2.1

version

string

可选

参与者的Zoom客户端版本。

示例值:

5.9.1.2581

join_time

string <date-time>

可选

参与者加入会议的时间。

示例值:

2022-03-01T10:15:14Z

mac_addr

string

可选

参与者的MAC地址。

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

示例值:

f85e-a012-92d8

user_id

string

可选

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

示例值:

20161536

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数据处理附录。

location

string

参与者的位置。

可选

示例值:

United States

string

可选

参与者的通用唯一ID。如果参与者通过登录Zoom加入网络研讨会，则此值与参与者的用户ID相同。如果参与者在未登录Zoom的情况下加入网络研讨会，则返回空值。

示例值:

_f08HhPJS82MIVLuuFaJPg

harddisk_id

string

可选

参与者的硬盘ID。

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

示例值:

Disk01

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

示例

{
    "next_page_token": "y20RGLOiO2jTy3CMfnNRORmB51kAuhMy0e2",
    "total_records": 2,
    "page_count": 2,
    "page_size": 1,
    "participants": [
        {
            "pc_name": "HW0010449",
            "leave_time": "2022-03-01T10:15:14Z",
            "user_qos": [
                {
                    "video_input": {
                        "avg_loss": "0.03%",
                        "max_loss": "0.4%",
                        "jitter": "0 ms",
                        "latency": "126 ms",
                        "bitrate": "27.15 kbps",
                        "frame_rate": "12 fps",
                        "resolution": "1280*720"
                    },
                    "wifi_rssi": {
                        "max_rssi": -75,
                        "avg_rssi": -69,
                        "min_rssi": -35,
                        "rssi_unit": "dBm"
                    },
                    "as_device_to_crc": {
                        "avg_loss": "0.03%",
                        "max_loss": "0.4%",
                        "jitter": "0 ms",
                        "latency": "126 ms",
                        "bitrate": "27.15 kbps",
                        "frame_rate": "12 fps",
                        "resolution": "1280*720"
                    },
                    "video_output": {
                        "avg_loss": "0.03%",
                        "max_loss": "0.4%",
                        "jitter": "0 ms",
                        "latency": "126 ms",
                        "bitrate": "27.15 kbps",
                        "frame_rate": "12 fps",
                        "resolution": "1280*720"
                    },
                    "video_device_from_crc": {
                        "avg_loss": "0.03%",
                        "max_loss": "0.03%",
                        "jitter": "0 ms",
                        "latency": "126 ms",
                        "bitrate": "27.15 kbps",
                        "frame_rate": "12 fps",
                        "resolution": "1280*720"
                    },
                    "as_device_from_crc": {
                        "avg_loss": "0.03%",
                        "max_loss": "0.4%",
                        "jitter": "0 ms",
                        "latency": "126 ms",
                        "bitrate": "27.15 kbps",
                        "frame_rate": "12 fps",
                        "resolution": "1280*720"
                    },
                    "audio_device_from_crc": {
                        "avg_loss": "0.03%",
                        "max_loss": "0.4%",
                        "jitter": "0 ms",
                        "latency": "126 ms",
                        "bitrate": "27.15 kbps"
                    },
                    "as_input": {
                        "avg_loss": "0.03%",
                        "max_loss": "0.4%",
                        "jitter": "0 ms",
                        "latency": "126 ms",
                        "bitrate": "27.15 kbps",
                        "frame_rate": "12 fps",
                        "resolution": "1280*720"
                    },
                    "video_device_to_crc": {
                        "avg_loss": "0.03%",
                        "max_loss": "0.4%",
                        "jitter": "0 ms",
                        "latency": "126 ms",
                        "bitrate": "27.15 kbps",
                        "frame_rate": "12 fps",
                        "resolution": "1280*720"
                    },
                    "audio_output": {
                        "avg_loss": "0.03%",
                        "max_loss": "0.4%",
                        "jitter": "0 ms",
                        "latency": "126 ms",
                        "bitrate": "27.15 kbps"
                    },
                    "as_device_to_rwg": {
                        "avg_loss": "0.03%",
                        "max_loss": "0.4%",
                        "jitter": "0 ms",
                        "latency": "126 ms",
                        "bitrate": "27.15 kbps",
                        "frame_rate": "12 fps",
                        "resolution": "1280*720"
                    },
                    "audio_device_to_crc": {
                        "avg_loss": "0.03%",
                        "max_loss": "0.4%",
                        "jitter": "0 ms",
                        "latency": "126 ms",
                        "bitrate": "27.15 kbps"
                    },
                    "date_time": "2022-03-01T10:16:00Z",
                    "video_device_from_rwg": {
                        "avg_loss": "0.03%",
                        "max_loss": "0.03%",
                        "jitter": "0 ms",
                        "latency": "126 ms",
                        "bitrate": "27.15 kbps",
                        "frame_rate": "12 fps",
                        "resolution": "1280*720"
                    },
                    "as_output": {
                        "avg_loss": "0.03%",
                        "max_loss": "0.4%",
                        "jitter": "0 ms",
                        "latency": "126 ms",
                        "bitrate": "27.15 kbps",
                        "frame_rate": "12 fps",
                        "resolution": "1280*720"
                    },
                    "audio_device_from_rwg": {
                        "avg_loss": "0.03%",
                        "max_loss": "0.4%",
                        "jitter": "0 ms",
                        "latency": "126 ms",
                        "bitrate": "27.15 kbps"
                    },
                    "as_device_from_rwg": {
                        "avg_loss": "0.03%",
                        "max_loss": "0.4%",
                        "jitter": "0 ms",
                        "latency": "126 ms",
                        "bitrate": "27.15 kbps",
                        "frame_rate": "12 fps",
                        "resolution": "1280*720"
                    },
                    "audio_input": {
                        "avg_loss": "0.03%",
                        "max_loss": "0.4%",
                        "jitter": "0 ms",
                        "latency": "126 ms",
                        "bitrate": "27.15 kbps"
                    },
                    "cpu_usage": {
                        "system_max_cpu_usage": "11%",
                        "zoom_avg_cpu_usage": "0%",
                        "zoom_min_cpu_usage": "0%",
                        "zoom_max_cpu_usage": "2%"
                    },
                    "audio_device_to_rwg": {
                        "avg_loss": "0.03%",
                        "max_loss": "0.4%",
                        "jitter": "0 ms",
                        "latency": "126 ms",
                        "bitrate": "27.15 kbps"
                    },
                    "video_device_to_rwg": {
                        "avg_loss": "0.03%",
                        "max_loss": "0.4%",
                        "jitter": "0 ms",
                        "latency": "126 ms",
                        "bitrate": "27.15 kbps",
                        "frame_rate": "12 fps",
                        "resolution": "1280*720"
                    }
                }
            ],
            "user_name": "jchill",
            "ip_address": "192.0.2.1",
            "version": "5.9.1.2581",
            "join_time": "2022-03-01T10:15:14Z",
            "mac_addr": "f85e-a012-92d8",
            "user_id": "20161536",
            "domain": "example.com",
            "internal_ip_addresses": [
                "192.0.2.1"
            ],
            "location": "United States",
            "id": "_f08HhPJS82MIVLuuFaJPg",
            "harddisk_id": "Disk01",
            "device": "Phone"
        }
    ]
}

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

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

列出网络研讨会参与者QoS

请求参数

示例代码

返回响应