Zoom API 中文版
  1. Dashboards
Zoom API 中文版
  • 说明
  • Meetings
    • 获取会议投票
      GET
    • 删除会议投票
      DELETE
    • 更新会议投票
      PUT
    • 更新livestream
      PATCH
    • 获取livestream详细信息
      GET
    • 创建会议
      POST
    • 列出会议
      GET
    • 获取会议注册人
      GET
    • 删除会议注册人
      DELETE
    • 执行批量注册
      POST
    • 更新注册问题
      PATCH
    • 列出登记问题
      GET
    • 获取会议的令牌
      GET
    • 更新会议调查
      PATCH
    • 获取会议调查
      GET
    • 删除会议调查
      DELETE
    • 使用会议中控件
      PATCH
    • 列出过去的会议实例
      GET
    • 更新会议状态
      PUT
    • 获取会议邀请
      GET
    • 从现有会议创建会议模板
      POST
    • 列出会议模板
      GET
    • 更新注册人的状态
      PUT
    • 创建会议的邀请链接
      POST
    • 执行批量轮询创建
      POST
    • 更新会议
      PATCH
    • 得到一个会议
      GET
    • 删除会议
      DELETE
    • 更新实时流状态
      PATCH
    • 添加会议注册人
      POST
    • 列出会议注册人
      GET
    • 创建会议投票
      POST
    • 列出会议投票
      GET
  • Billing
    • 列出开票发票
    • 列出即将续订的帐户
    • 生成子帐户的开单发票报告
    • 列出子帐户的开单发票报表
    • 订阅计划的帐户
    • 获取客户计划信息
    • 获取发票详细信息
    • 取消基本计划
    • 订阅额外计划的帐户
    • 更新帐户的附加计划
    • 更新帐单信息
    • 获取账单信息
    • 下载子帐户的帐单发票报告
    • 删除子帐户的开单发票报表
    • 更新基本计划
    • 获取计划使用情况
    • 下载发票文件
    • 取消其他计划
  • SIP Phone
    • 启用SIP电话
    • 列出SIP电话
    • 更新SIP电话
    • 删除SIP电话
  • Users
    • 获取协作设备详细信息
    • 添加助理
    • 列出用户助理
    • 删除用户助理
    • 获取用户的令牌
    • 撤销用户的SSO令牌
    • 切换用户的帐户
    • 删除用户助理
    • 列出用户的协作设备
    • 更新用户的密码
    • 上传用户的个人资料图片
    • 删除用户的个人资料图片
    • 更新用户状态
    • 批量更新功能
    • 创建用户
    • 列出用户
    • 上传虚拟后台文件
    • 删除虚拟背景文件
    • 列出用户调度程序
    • 删除用户计划程序
    • 获取用户权限
    • 删除计划程序
    • 获取用户摘要
    • 更新用户设置
    • 获取用户设置
    • 更新用户的电子邮件
    • 更新用户
    • 获取用户
    • 删除用户
  • Reports
    • 获取网络研讨会详细信息报告
    • 获取网络研讨会问答报告
    • 获取登录/注销活动报告
    • 获取会议参与者报告
    • 获取会议报告
    • 获取会议详细信息报告
    • 获取会议问答报告
    • 获取会议投票报告
    • 获取每日使用情况报告
    • 获取操作日志报告
    • 获取活动/非活动主机报告
    • 获取账单报告
    • 获取即将发生的事件报告
    • 获取云记录使用情况报告
    • 获取帐单发票报告
    • 获取电话报告
    • 获取网络研讨会参与者报告
    • 获取网络研讨会投票报告
  • Groups
    • 更新群组的设置
    • 获取组的设置
    • 创建组
    • 列表组
    • 添加组管理员
    • 列表组管理员
    • 添加组成员
    • 列出组成员
    • 更新小组的网络研讨会注册设置
    • 获取小组的网络研讨会注册设置
    • 上传虚拟后台文件
    • 删除虚拟背景文件
    • 删除组管理员
    • 更新锁定设置
    • 获取锁定设置
    • 更新组成员
    • 删除组成员
    • 更新群组
    • 获取一个组
    • 删除群组
  • H323 Devices
    • 创建H.323/SIP设备
    • 列出H.323/SIP设备
    • 更新H.323/SIP设备
    • 删除H.323/SIP设备
  • Webinars
    • 创建网络研讨会模板
    • 列出网络研讨会模板
    • 更新实时流状态
    • 设置网络研讨会的默认品牌虚拟背景
    • 上传网络研讨会的品牌虚拟背景
    • 删除网络研讨会的品牌虚拟背景
    • 创建网络研讨会
    • 列出网络研讨会
    • 执行批量注册
    • 更新网络研讨会
    • 获取网络研讨会
    • 删除网络研讨会
    • 创建网络研讨会的邀请链接
    • 更新网络研讨会的品牌名称标签
    • 更新注册人的状态
    • 获取缺席的网络研讨会
    • 获取网络研讨会的会议品牌推广
    • 获取网络研讨会注册人
    • 删除网络研讨会注册人
    • 获取网络研讨会的令牌
    • 更新实时流
    • 获取实时流详细信息
    • 创建网络研讨会的投票
    • 列出网络研讨会的民意调查
    • 获取网络研讨会跟踪源
    • 更新注册问题
    • 列出登记问题
    • 更新网络研讨会状态
    • 添加小组成员
    • 小组成员名单
    • 删除网络研讨会小组成员
    • 更新网络研讨会调查
    • 获取网络研讨会调查
    • 删除网络研讨会调查
    • 添加网络研讨会注册人
    • 列出网络研讨会注册人
    • 删除小组成员
    • 获取网络研讨会投票
    • 删除网络研讨会投票
    • 更新网络研讨会投票
    • 创建网络研讨会的品牌名称标签
    • 删除网络研讨会的品牌名称标签
    • 上传网络研讨会的品牌壁纸
    • 删除网络研讨会的品牌壁纸
    • 列出过去的网络研讨会实例
  • Tracking Field
    • 创建跟踪字段
    • 列表跟踪字段
    • 更新跟踪字段
    • 获取跟踪字段
    • 删除跟踪字段
  • Dashboards
    • 获取聊天指标
      GET
    • 列表缩放会议客户反馈
      GET
    • 获取post网络研讨会反馈
      GET
    • 获取CRC端口使用情况
      GET
    • 列出会议参与者
      GET
    • 获取会议共享/录制详细信息
      GET
    • 列出网络研讨会参与者QoS
      GET
    • 列出客户会议满意度
      GET
    • 获取缩放房间的问题
      GET
    • 获取会议参与者QoS
      GET
    • 获得有问题的前25个缩放房间
      GET
    • 列出客户端版本
      GET
    • 获取网络研讨会详细信息
      GET
    • 获取缩放房间详细信息
      GET
    • 获取网络研讨会参与者QoS
      GET
    • 获取zoom会议客户反馈
      GET
    • 获取网络研讨会参与者
      GET
    • 获取网络研讨会共享/录制详细信息
      GET
    • 获取缩放房间的前25个问题
      GET
    • 获取会议质量分数
      GET
    • 列出会议
      GET
    • 列表缩放房间
      GET
    • 获取会议后反馈
      GET
    • 列出网络研讨会
      GET
    • 获取会议详细信息
      GET
    • 列出会议参与者QoS
      GET
  • Dashboards Copy
    • 获取聊天指标
    • 列表缩放会议客户反馈
    • 获取post网络研讨会反馈
    • 获取CRC端口使用情况
    • 列出会议参与者
    • 获取会议共享/录制详细信息
    • 列出网络研讨会参与者QoS
    • 列出客户会议满意度
    • 获取缩放房间的问题
    • 获取会议参与者QoS
    • 获得有问题的前25个缩放房间
    • 列出客户端版本
    • 获取网络研讨会详细信息
    • 获取缩放房间详细信息
    • 获取网络研讨会参与者QoS
    • 获取zoom会议客户反馈
    • 获取网络研讨会参与者
    • 获取网络研讨会共享/录制详细信息
    • 获取缩放房间的前25个问题
    • 获取会议质量分数
    • 列出会议
    • 列表缩放房间
    • 获取会议后反馈
    • 列出网络研讨会
    • 获取会议详细信息
    • 列出会议参与者QoS
  • Cloud Recording
    • 列出帐户的记录
    • 获取会议录音
    • 删除会议录制
    • 创建录音注册人
    • 列表记录注册人
    • 获取会议记录的分析详细信息
    • 恢复会议录制
    • 恢复单个录制
    • 更新注册问题
    • 获取注册问题
    • 获取会议记录的分析摘要
    • 更新注册人的状态
    • 更新会议录制设置
    • 获取会议录制设置
    • 列出所有录音
    • 删除会议录制文件
  • TSP
    • 更新帐户的TSP信息
    • 获取帐户的TSP信息
    • 更新TSP帐户
    • 获取用户的TSP帐户
    • 删除用户的TSP帐户
    • 设置TSP用户的全局拨入URL
    • 添加用户的TSP帐户
    • 列出用户的TSP帐户
  • SIP Connected Audio
    • 更新内部号码
    • 删除内部号码
    • 分配SIP中继配置
    • 获取SIP中继配置
    • 分配SIP中继
    • 列出SIP中继
    • 列出SIP中继号码
    • 删除内部呼叫国家/地区
    • 添加内部调出国家/地区
    • 列出内部调出国家/地区
    • 分配编号
    • 删除所有号码
    • 添加内部编号
    • 列出内部号码
    • 删除SIP中继
  • Accounts
    • 获取帐户的受信任域
    • 创建子账户
    • 列出子帐户
    • 获取子帐户详细信息
    • 取消子帐户的关联
    • 更新选项
    • 更新锁定设置
    • 获取锁定设置
    • 更新帐户所有者
    • 更新帐户设置
    • 获取帐户设置
    • 上传虚拟后台文件
    • 删除虚拟背景文件
    • 更新帐户的网络研讨会注册设置
    • 获取帐户的网络研讨会注册设置
    • 获取帐户的托管域
  • PAC
    • 列出用户的PAC帐户
  • Information Barriers
    • 更新信息壁垒政策
    • 通过ID获取信息屏障策略
    • 消除信息屏障策略
    • 创建信息屏障策略
    • 列出信息屏障政策
  • IM Groups
    • 创建IM目录组
    • 列出IM目录组
    • 添加IM目录组成员
    • 列出IM目录组成员
    • 更新IM目录组
    • 检索IM目录组
    • 删除IM目录组
    • 删除IM目录组成员
  • Roles
    • 创建角色
    • 列出角色
    • 更新角色信息
    • 获取角色信息
    • 删除角色
    • 分配角色
    • 列出角色中的成员
    • 取消分配角色
  • Archiving
    • 列出已存档的文件
  1. Dashboards

获取网络研讨会参与者QoS

GET
/accounts/{accountId}/metrics/webinars/{webinarId}/participants/{participantId}/qos
Dashboards
在实时或过去的网络研讨会期间返回参与者的服务质量 (QoS)。返回的该数据指示用于发送/接收视频、音频和共享内容的连接质量。API会针对API请求或上次接收API请求的时间返回此数据。
当发送方发送其数据时,时间戳被附加到发送方的数据分组。然后,接收方将该时间戳返回给发送方。这有助于确定上游和下游延迟,其中包括应用程序处理时间。返回的延迟数据是五秒平均值和五秒最大值。
如果在请求时没有发送或接收数据,该API将 ** 不返回 ** 数据。
** 注: **
当帐户调用此API时,此API可能会为参与者的 “user_name” 、 “ip_address” 、 “location” 和 “email” 响应返回空值:
没有 ** 签署的HIPAA商业伙伴协议 (BAA)。
是 ** legacy ** HIPAA BAA帐户。
显示 ** 不属于 ** 主机帐户的任何用户的数据,例如外部用户,除非他们满足某些条件。有关详细信息,请参阅 [电子邮件地址显示规则](https://developers.zoom.us/docs/api/rest/使用-缩放-api/# 电子邮件地址-显示-规则)。
** 先决条件: **
设置Zoom Rooms的商业、教育或API计划。
** [速率限制标签](https://marketplace.zoom.us/docs/api参考/速率限制 # 速率限制):** “沉重”

请求参数

Path 参数
webinarId
string 
必需
网络研讨会的ID或通用唯一ID (UUID)。
如果您提供网络研讨会ID,API将返回最新网络研讨会实例的响应。
如果您提供以 “/” 字符开头或包含 “//” 字符的网络研讨会UUID,则必须 ** 在发出API请求之前对网络研讨会UUID进行双编码。
participantId
string 
参与者的ID。
必需
accountId
string 
帐户的唯一标识符。
必需
Query 参数
type
string 
可选
要查询的网络研讨会的类型。
'过去'-所有过去的网络研讨会。
'live'-所有实时网络研讨会。
此值默认为 “live”。

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://prod-cn.your-api-server.com/accounts//metrics/webinars//participants//qos'

返回响应

🟢200** HTTP状态代码: ** '200' 网络研讨会参与者QOS已返回。 此API仅适用于已启用仪表板功能的ZMP和企业或更高版本帐户。
application/json
Body
有关参与者及其服务质量 (QoS) 的信息。
pc_name
string 
参与者的PC名称。
可选
示例值:
HW0010449
leave_time
string <date-time>
可选
参与者离开会议的时间。
示例值:
2022-03-01T10:15:14Z
user_qos
array [object {21}] 
可选
参与者的服务质量信息。
video_input
object 
视频QoS对象
可选
wifi_rssi
object 
可选
由通过无线网络加入会议的参与者发送的无线网络RSSI的QoS度量。
as_device_to_crc
object 
可选
通过CRC加入会议的参与者收到的屏幕共享输出的QoS度量。
video_output
object 
视频QoS对象
可选
video_device_from_crc
object 
可选
由通过CRC加入会议的参与者发送的视频输入的QoS度量。
as_device_from_crc
object 
可选
通过CRC加入会议的参与者进行屏幕共享的QoS度量。
audio_device_from_crc
object 
可选
通过云室连接器 (CRC) 加入会议的参与者发送的音频的QoS度量。
as_input
object 
屏幕共享QoS对象
可选
video_device_to_crc
object 
可选
由通过CRC加入会议的参与者发送的视频输出的QoS度量。
audio_output
object 
音频QoS对象
可选
as_device_to_rwg
object 
可选
由通过web客户端加入会议的参与者接收的屏幕共享的QoS输出度量。
audio_device_to_crc
object 
可选
通过CRC加入会议的参与者接收的音频的QoS度量。
date_time
string <date-time>
QoS日期和时间。
可选
示例值:
2022-03-01T10:16:00Z
video_device_from_rwg
object 
可选
由通过web客户端加入会议的参与者发送的视频输入的QoS度量。
as_output
object 
屏幕共享QoS对象
可选
audio_device_from_rwg
object 
可选
通过web客户端加入会议的参与者发送的音频的QoS度量。
as_device_from_rwg
object 
可选
通过web客户端加入会议的参与者进行屏幕共享的QoS度量。
audio_input
object 
音频QoS对象
可选
cpu_usage
object 
可选
audio_device_to_rwg
object 
可选
通过web客户端加入会议的参与者接收的音频的QoS度量。
video_device_to_rwg
object 
可选
由通过web客户端加入会议的参与者发送的视频输出的QoS度量。
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
id
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
示例
{
    "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' <br> 错误的请求 ** 错误码: ** '12702' <br> 一年前无法访问网络研讨会。<br>
🟠404** HTTP状态代码: ** '404' <br> 未找到 ** 错误代码: ** '3001' <br> 此网络研讨会的详细信息不可用或ID无效。<br>

扫码加 ZOOM 开发者 微信交流

在这里,获得 ZOOM API 文档 使用上的任何帮助,快速上手让你的研测效率得到大幅提升

扫码加入交流群
上一页
获取缩放房间详细信息
下一页
获取zoom会议客户反馈
Built with