Zoom API 中文版
  1. Webinars
Zoom API 中文版
  • 说明
  • Meetings
    • 获取会议投票
    • 删除会议投票
    • 更新会议投票
    • 更新livestream
    • 获取livestream详细信息
    • 创建会议
    • 列出会议
    • 获取会议注册人
    • 删除会议注册人
    • 执行批量注册
    • 更新注册问题
    • 列出登记问题
    • 获取会议的令牌
    • 更新会议调查
    • 获取会议调查
    • 删除会议调查
    • 使用会议中控件
    • 列出过去的会议实例
    • 更新会议状态
    • 获取会议邀请
    • 从现有会议创建会议模板
    • 列出会议模板
    • 更新注册人的状态
    • 创建会议的邀请链接
    • 执行批量轮询创建
    • 更新会议
    • 得到一个会议
    • 删除会议
    • 更新实时流状态
    • 添加会议注册人
    • 列出会议注册人
    • 创建会议投票
    • 列出会议投票
  • 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
    • 创建网络研讨会模板
      POST
    • 列出网络研讨会模板
      GET
    • 更新实时流状态
      PATCH
    • 设置网络研讨会的默认品牌虚拟背景
      PATCH
    • 上传网络研讨会的品牌虚拟背景
      POST
    • 删除网络研讨会的品牌虚拟背景
      DELETE
    • 创建网络研讨会
      POST
    • 列出网络研讨会
      GET
    • 执行批量注册
      POST
    • 更新网络研讨会
      PATCH
    • 获取网络研讨会
      GET
    • 删除网络研讨会
      DELETE
    • 创建网络研讨会的邀请链接
      POST
    • 更新网络研讨会的品牌名称标签
      PATCH
    • 更新注册人的状态
      PUT
    • 获取缺席的网络研讨会
      GET
    • 获取网络研讨会的会议品牌推广
      GET
    • 获取网络研讨会注册人
      GET
    • 删除网络研讨会注册人
      DELETE
    • 获取网络研讨会的令牌
      GET
    • 更新实时流
      PATCH
    • 获取实时流详细信息
      GET
    • 创建网络研讨会的投票
      POST
    • 列出网络研讨会的民意调查
      GET
    • 获取网络研讨会跟踪源
      GET
    • 更新注册问题
      PATCH
    • 列出登记问题
      GET
    • 更新网络研讨会状态
      PUT
    • 添加小组成员
      POST
    • 小组成员名单
      GET
    • 删除网络研讨会小组成员
      DELETE
    • 更新网络研讨会调查
      PATCH
    • 获取网络研讨会调查
      GET
    • 删除网络研讨会调查
      DELETE
    • 添加网络研讨会注册人
      POST
    • 列出网络研讨会注册人
      GET
    • 删除小组成员
      DELETE
    • 获取网络研讨会投票
      GET
    • 删除网络研讨会投票
      DELETE
    • 更新网络研讨会投票
      PUT
    • 创建网络研讨会的品牌名称标签
      POST
    • 删除网络研讨会的品牌名称标签
      DELETE
    • 上传网络研讨会的品牌壁纸
      POST
    • 删除网络研讨会的品牌壁纸
      DELETE
    • 列出过去的网络研讨会实例
      GET
  • 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
    • 列出已存档的文件
  1. Webinars

上传网络研讨会的品牌虚拟背景

POST
/accounts/{accountId}/webinars/{webinarId}/branding/virtual_backgrounds
Webinars
使用此API上传网络研讨会的会话品牌 虚拟背景。主持人和小组成员可以在网络研讨会期间选择和使用这些虚拟背景。品牌虚拟背景文件具有以下限制:
网络研讨会不能超过10个虚拟背景文件。
您只能上传JPG/JPEG,GIF或PNG格式的图像文件。
虚拟背景文件大小不能超过15兆字节 (MB)。
** 先决条件: **
** 网络研讨会会话品牌 ** 设置已启用。
** 范围: ** 'webinar:master'
** [速率限制标签](https://marketplace.zoom.us/docs/api-reference/Rate-limits # 速率限制):** 'Medium'

请求参数

Path 参数
webinarId
integer 
网络研讨会的ID。
必需
accountId
string 
帐户的唯一标识符。
必需
Body 参数multipart/form-data
set_default_for_all_panelists
string 
可选
是否将虚拟背景文件设置为所有小组成员的新默认值。这包括当前未分配默认虚拟背景的小组成员。
示例值:
true
default
string 
可选
是否将该文件设置为默认虚拟背景文件。
示例值:
true
file
file 
必需
虚拟背景的文件路径,采用二进制格式。
示例值:
WVVoU01HTklUVFpNZVRsc1pVZEdkR05IZUd4TWJVNTJZbEU5UFE9PQ==

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://prod-cn.your-api-server.com/accounts//webinars//branding/virtual_backgrounds' \
--form 'file=@"WVVoU01HTklUVFpNZVRsc1pVZEdkR05IZUd4TWJVNTJZbEU5UFE9PQ=="'

返回响应

🟢201** HTTP状态代码: ** '201' 虚拟背景已上传。
application/json
Body
size
integer 
可选
虚拟背景文件的大小 (以字节为单位)。
示例值:
524288
name
string 
可选
虚拟背景文件的名称。
示例值:
beach.jpg
id
string 
可选
虚拟背景文件的ID。
示例值:
J0sFXN2PSOCGrqTqLRwgAQ
is_default
boolean 
可选
文件是否为默认虚拟背景文件。
示例值:
true
type
enum<string> 
可选
虚拟背景文件的文件类型:
'image'-图像文件。
枚举值:
image
示例值:
image
示例
{
    "size": 524288,
    "name": "beach.jpg",
    "id": "J0sFXN2PSOCGrqTqLRwgAQ",
    "is_default": true,
    "type": "image"
}
🟠400** HTTP状态代码: ** '400' <br> 错误的请求 ** 错误码: ** '3000' <br> 此网络研讨会未启用会话品牌。 ** 错误代码: ** '120' <br> * 没有上传文件。验证文件是否已上载。 * 文件大小不能超过15m。 * 网络研讨会最多允许10个文件。 * 只能上传JPG/JPEG,GIF或PNG图像文件。
🟠404** HTTP状态代码: ** '404' <br> 未找到 ** 错误代码: ** '1001' <br> 用户 “{userId}” 不存在或不属于此帐户。 ** 错误代码: ** '3001' <br> 网络研讨会 “{webinarId}” 未找到或已过期。

扫码加 ZOOM 开发者 微信交流

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

扫码加入交流群
上一页
设置网络研讨会的默认品牌虚拟背景
下一页
删除网络研讨会的品牌虚拟背景
Built with