Zoom API 中文版
Billing
复制页面
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
列出开票发票
GET
列出即将续订的帐户
GET
生成子帐户的开单发票报告
POST
列出子帐户的开单发票报表
GET
订阅计划的帐户
POST
获取客户计划信息
GET
获取发票详细信息
GET
取消基本计划
PATCH
订阅额外计划的帐户
POST
更新帐户的附加计划
PUT
更新帐单信息
PATCH
获取账单信息
GET
下载子帐户的帐单发票报告
GET
删除子帐户的开单发票报表
DELETE
更新基本计划
PUT
获取计划使用情况
GET
下载发票文件
GET
取消其他计划
PATCH
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
获取聊天指标
列表缩放会议客户反馈
获取post网络研讨会反馈
获取CRC端口使用情况
列出会议参与者
获取会议共享/录制详细信息
列出网络研讨会参与者QoS
列出客户会议满意度
获取缩放房间的问题
获取会议参与者QoS
获得有问题的前25个缩放房间
列出客户端版本
获取网络研讨会详细信息
获取缩放房间详细信息
获取网络研讨会参与者QoS
获取zoom会议客户反馈
获取网络研讨会参与者
获取网络研讨会共享/录制详细信息
获取缩放房间的前25个问题
获取会议质量分数
列出会议
列表缩放房间
获取会议后 反馈
列出网络研讨会
获取会议详细信息
列出会议参与者QoS
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
列出已存档的文件
Billing
MCP
复制页面
获取客户计划信息
GET
/accounts/{accountId}/plans
调试
Run in Apifox
Run in Apifox
主账户可以检索其子账户的计划信息。
** 先决条件 **: 此API只能由支付其关联的Pro或更高版本子帐户的所有账单费用的主帐户使用。
Zoom仅允许批准的合作伙伴使用
主api
和管理子帐户的计费信息。向合作伙伴计划团队发送电子邮件至
** partner-success@zoom.us **
了解更多详细信息。
** 范围: ** 'billing:master'
** [速率限制标签](
https://marketplace.zoom.us/docs/api-reference/Rate-limits
# 速率限制):** 'MEDIUM'
请求参数
Path 参数
生成代码
accountId
string
帐户的唯一标识符。
必需
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例
请求示例
Shell
JavaScript
Java
Swift
cURL
cURL-Windows
Httpie
wget
PowerShell
curl
--location
--request
GET
'http://prod-cn.your-api-server.com/accounts//plans'
返回响应
🟢
200
** HTTP状态代码: ** '200' 帐户的计划已返回。
application/json
生成代码
Body
生成代码
plan_recording
string
可选
帐户的 [云记录计划](
https://marketplace.zoom.us/docs/api参考/其他参考/计划
# 云记录计划)。
示例值:
cmr_monthly_commitment_40
plan_recording_service_effective_date
string
可选
云录制计划对该帐户生效的日期。
示例值:
2021-08-08
plan_zsched
object
可选
有关帐户的缩放计划程序计划的信息。
service_effective_date
string
可选
计划对帐户生效的日期。
示例值:
2022-05-01
hosts
integer
帐户计划的主机数。
可选
示例值:
12
type
string
可选
缩放计划程序计划类型
。
示例值:
zsched_yearly
next_invoice_date
string
可选
帐户计划的下一个发票日期。
示例值:
2022-06-01
status
enum<string>
可选
客户计划的状态。
“活动”-活动。
“已取消”-已取消。
“已过期”-已过期。
枚举值:
active
cancelled
expired
示例值:
active
plan_whiteboard
object
可选
有关帐户的Zoom白板计划的信息。
service_effective_date
string
可选
计划对帐户生效的日期。
示例值:
2022-04-15
hosts
integer
帐户计划的主机数。
可选
示例值:
18
type
string
可选
[缩放白板计划类型](
https://marketplace.zoom.us/docs/api-参考/其他-参考/计划/#
缩放-白板-计划)。
示例值:
zwb_monthly
next_invoice_date
string
可选
帐户计划的下一个发票日期。
示例值:
2022-05-15
status
enum<string>
可选
客户计划的状态。
“活动”-活动。
“已取消”-已取消。
“已过期”-已过期。
枚举值:
active
cancelled
expired
示例值:
active
plan_zoom_one
array
[object {5}]
可选
有关帐户的Zoom One Biz Plus计划的信息。
service_effective_date
string
可选
计划对帐户生效的日期。
示例值:
2022-03-01
hosts
integer
帐户计划的主机数。
可选
示例值:
20
type
string
可选
Zoom One Biz Plus计划类型
。
示例值:
zobp_usca_monthly_unlimited
next_invoice_date
string
可选
帐户计划的下一个发票日期。
示例值:
2022-05-01
status
enum<string>
可选
客户计划的状态。
“活动”-活动。
“已取消”-已取消。
“已过期”-已过期。
枚举值:
active
cancelled
expired
示例值:
active
plan_sdk_cmr
object
可选
有关帐户的Zoom视频SDK计划的信息。
type
string
可选
[视频SDK计划类型](
https://marketplace.zoom.us/docs/api-reference/其他-references/plans/#
Video-sdk-add-on-plans)。
示例值:
vsdk_cmr_monthly_100
plan_mesh
object
可选
有关帐户的缩放网格计划的信息。
service_effective_date
string
可选
计划对帐户生效的日期。
示例值:
2022-05-01
hosts
integer
帐户计划的主机数。
可选
示例值:
12
type
string
可选
[缩放网格计划类型](
https://marketplace.zoom.us/docs/api-reference/其他-references/plans/#
video-sdk-add-on-plans)。
示例值:
zmesh_monthly
next_invoice_date
string
可选
帐户计划的下一个发票日期。
示例值:
2022-06-01
status
enum<string>
可选
客户计划的状态。
“活动”-活动。
“已取消”-已取消。
“已过期”-已过期。
枚举 值:
active
cancelled
expired
示例值:
active
plan_zoom_iq
object
可选
有关帐户的Zoom Sales IQ计划的信息。
hosts
integer
帐户计划的主机数。
可选
示例值:
18
type
string
可选
缩放销售IQ计划类型
。
示例值:
ziq_sales_monthly
plan_zoom_events
array
[object {5}]
可选
有关帐户的Zoom事件计划的信息。
service_effective_date
string
可选
计划对帐户生效的日期。
示例值:
2022-05-01
hosts
integer
帐户计划的主机数。
可选
示例值:
12
type
string
可选
缩放事件计划类型
。
示例值:
zoomevents1000_monthly
next_invoice_date
string
可选
帐户计划的下一个发票日期。
示例值:
2022-06-01
status
enum<string>
可选
客户计划的状态。
“活动”-活动。
“已取消”-已取消。
“已过期”-已过期。
枚举值:
active
cancelled
expired
示例值:
active
plan_recording_next_invoice_date
string
可选
帐户的云记录计划的下一个发票日期。
示例值:
2022-01-31
plan_zwr
object
可选
有关帐户的Zoom工作区预留计划的信息。
service_effective_date
string
可选
计划对帐户生效的日期。
示例值:
2022-05-01
hosts
integer
帐户计划的主机数。
可选
示例值:
12
type
string
可选
缩放工作区预留计划类型
。
示例值:
zwr_yearly
next_invoice_date
string
可选
帐户计划的下一个发票日期。
示例值:
2022-06-01
status
enum<string>
可选
客户计划的状态。
“活动”-活动。
“已取消”-已取消。
“已过期”-已过期。
枚举值:
active
cancelled
expired
示例值:
active
plan_qss
array
[object {5}]
可选
有关帐户的Zoom质量流服务计划的信息。
service_effective_date
string
可选
计划对帐户生效的日期。
示例值:
2022-05-01
hosts
integer
帐户计划的主机数。
可选
示例值:
12
type
string
可选
缩放质量流服务计划类型
。
示例值:
quality_stream1_free_trial
next_invoice_date
string
可选
帐户计划的下一个发票日期。
示例值:
2022-06-01
status
enum<string>
可选
客户计划的状态。
“活动”-活动。
“已取消”-已取消。
“已过期”-已过期。
枚举值:
active
cancelled
expired
示例值:
active
plan_webinar
array
[object {5}]
可选
有关客户的网络研讨会计划的信息。
service_effective_date
string
可选
计划对帐户生效的日期。
示例值:
2022-01-03
hosts
integer
帐户计划的主机数。
可选
示例值:
88
type
string
可选
[网络研讨会计划类型](
https://marketplace.zoom.us/docs/api-参考/其他-参考/计划
# 网络研讨会-计划)。
示例值:
webinar500_monthly
next_invoice_date
string
可选
帐户计划的下一个发票日期。
示例值:
2022-06-05
status
enum<string>
可选
客户计划的状态。
“活动”-活动。
“已取消”-已取消。
“已过期”-已过期。
枚举值:
active
cancelled
expired
示例值:
active
plan_zcc
object
可选
有关客户的Zoom联络中心计划的信息。
plan_package
object
可选
有关客户的Zoom联系中心套餐计划的信息。
plan_usage
array
[object {5}]
可选
有关帐户的其他Zoom联络中心呼叫计划的信息。
plan_phone_number
array
[object {5}]
可选
有关帐户的其他Zoom联系中心号码计划的信息。
plan_znode
object
可选
有关帐户的缩放节点计划的信息。
plan_zphybrid
object
可选
有关帐户的Zoom节点电话混合计划的信息。
plan_mchybrid
object
可选
有关帐户的缩放节点会议连接器计划的信息。
plan_zmhybrid
object
可选
有关帐户的缩放节点会议混合计划的信息。
plan_znode_base
object
可选
有关帐户的缩放节点基本计划的信息。
plan_rchybrid
object
可选
有关帐户的Zoom节点记录连接器计划的信息。
plan_large_meeting
array
[object {5}]
可选
有关帐户的大型会议计划的信息。
service_effective_date
string
可选
计划对帐户生效的日期。
示例值:
2022-03-01
hosts
integer
帐户计划的主机数。
可选
示例值:
20
type
string
可选
[大型会议计划类型](
https://marketplace.zoom.us/docs/api-参考/其他-参考/计划
# 大型-会议-计划)。
示例值:
large500_monthly
next_invoice_date
string
可选
帐户计划的下一个发票日期。
示例值:
2022-05-01
status
enum<string>
可选
客户计划的状态。
“活动”-活动。
“已取消”-已取消。
“已过期”-已过期。
枚举值:
active
cancelled
expired
示例值:
active
plan_audio
object
可选
有关帐户的音频会议计划的信 息。
service_effective_date
string
可选
计划对帐户生效的日期。
示例值:
2021-12-31
premium_countries
string
可选
帐户的高级国家/地区的逗号分隔列表。
有关值的列表,请参阅 [高级国家/地区](
https://marketplace.zoom.us/docs/api-reference/other-references/breablation-lists
# Premium) 表中的 “id” 字段。
示例值:
US, CN
tollfree_countries
string
可选
以逗号分隔的帐户免费国家列表
有关值的列表,请参阅 [免费电话国家](
https://marketplace.zoom.us/docs/api-reference/other-references/breablation-lists
# 免费电话) 表中的 “id” 字段。
示例值:
US, CN
callout_countries
string
可选
以逗号分隔的帐户调出国家/地区列表。
有关值的列表,请参阅 [TSP标注国家](
https://marketplace.zoom.us/docs/api-reference/other-references/breablation-lists
# tsp-国家) 表中的 “id” 字段。
示例值:
US, CN
type
string
可选
[音频会议计划类型](
https://marketplace.zoom.us/docs/api参考/其他参考/计划
# 音频会议计划)。
示例值:
tollfree_payongo
ddi_numbers
integer
可选
帐户的专用拨入 (DDI) 号码。
示例值:
800
next_invoice_date
string
可选
帐户计划的下一个发票日期。
示例值:
2022-04-05
status
enum<string>
可选
客户计划的状态。