Zoom API 中文版
  1. Meetings
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
    • 获取聊天指标
    • 列表缩放会议客户反馈
    • 获取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. Meetings

创建会议

POST
/accounts/{accountId}/users/{userId}/meetings
Meetings
创建会议。对于用户级应用,传递 ['me' 值](/docs/api/rest/using-zoom-apis/# the-me-keyword) 而不是 'userId' 参数。
会议的 “start_url” 值是主持人或备用主持人可用于启动会议的URL。对于所有普通用户,“start_url” 值的过期时间为 ** 两小时 **。
对于 'custCreate' 会议主持人 (通过 [** 创建用户 **](/api-reference/zoom-api/methods # operation/userCreate) api使用 'custCreate' 参数创建的用户),'start_url' 参数的过期时间是从生成 'start_url' 开始的 ** 90天 **。
** 注: **
出于安全原因,在过期后以编程方式获取更新的 “start_url” 值的推荐方法是调用 [** 获取会议 **](/api-reference/zoo-api/methods # operation/meeting) API。参考响应中的 “start_url” 值。
** 每天100个请求 **。速率限制应用于用于发出请求的 ** 会议主持人 ** 的 “userid”。
** 范围: ** 'meeting:master'
** [速率限制标签](https://marketplace.zoom.us/docs/api-reference/Rate-limits # 速率限制):** 'MEDIUM'

请求参数

Path 参数
userId
string 
必需
用户的用户ID或电子邮件地址。对于用户级应用,传递 “我” 值。
accountId
string 
帐户的唯一标识符。
必需
Body 参数application/json
基本会议对象。
settings
object 
可选
有关会议设置的信息。
encryption_type
enum<string> 
可选
用于会议的 端到端 (E2EE) 加密 的类型。
'enhanced_encryption'-增强加密。启用此选项后,加密将存储在云中。
“e2ee”-端到端加密。加密密钥存储在您的本地设备上,** 其他任何人都无法 ** 获得。当您使用E2EE加密时,某些功能,例如云录音或电话和SIP/H.323拨入,是 ** 禁用 **。
枚举值:
enhanced_encryptione2ee
示例值:
enhanced_encryption
authentication_option
string 
可选
如果 “meeting_authentication” 值为 “true”,则为用户加入会议所需的身份验证类型。
要获取此值,在 [** 获取用户设置 **](/docs/api-reference/zoom-api/methods # operation/userSettings) api响应中使用 “authentication_options” 数组的 “id” 值。
示例值:
signIn_D8cJuqWVQ623CI4Q8yQK0Q
breakout_room
object 
可选
预先分配的分组会议室 设置。
sign_language_interpretation
object 
可选
会议的 手语翻译设置。确保在web门户中添加语言,以便在API中使用它。有关详细信息,请参见链接。
** 注意: ** 如果未在主持人的帐户上启用此功能,则此设置将 ** 不 ** 应用于会议。
additional_data_center_regions
array[string]
可选
添加其他会议 数据中心区域。提供此值作为 [国家/地区代码](/docs/api/rest/other-references/breablation-lists/# 国家/地区) 的数组在 ** 帐户配置文件 ** 界面中用作数据中心区域但已在 用户设置 中选择退出的国家/地区。
例如,在您的 ** 帐户配置文件 ** 中选择的数据中心区域是 “欧洲” 、 “香港sar” 、 “澳大利亚” 、 “印度” 、 “日本” 、 “中国” 、 “美国” 和 “加拿大”。但是,在 ** 我的个人资料 ** 设置中,您 ** 没有 ** 为会议和网络研讨会流量路由选择选择 “印度” 和 “日本”。
要将 “印度” 和 “日本” 作为附加数据中心,请使用此字段的 “[IN,TY]” 值。
show_share_button
boolean 
可选
是否在会议的注册页面上包括社交媒体共享按钮。此设置仅应用于启用了注册的会议。
示例值:
true
focus_mode
boolean 
可选
会议开始时是否启用 ** 焦点模式 ** 功能。
示例值:
true
registrants_confirmation_email
boolean 
可选
是否向注册人发送电子邮件确认。
“真”-发送确认电子邮件。
'false'-不要发送确认电子邮件。
示例值:
true
approved_or_denied_countries_or_regions
object 
可选
来自特定国家或地区的可加入会议的已批准或已阻止用户的列表。
registration_type
enum<integer> 
可选
会议的注册类型。
'1'-与会者注册一次,可以参加任何会议。
'2'-与会者必须为每次会议注册。
“3”-与会者注册一次,可以选择一个或多个会议事件参加。
此字段仅适用于具有固定时间 (“8”) 的定期会议。此值默认为 “1”。
枚举值:
123
默认值:
1
示例值:
1
contact_email
string 
可选
会议注册的联系人电子邮件地址。
示例值:
jchill@example.com
continuous_meeting_chat
object 
可选
有关 ** 启用连续会议聊天 ** 功能的信息。
allow_multiple_devices
boolean 
可选
是否允许与会者从多个设备加入会议。此设置仅应用于启用了注册的会议。
示例值:
true
meeting_authentication
boolean 
可选
如果为true,则只有 authenticated 用户可以加入会议。
示例值:
true
waiting_room
boolean 
可选
是否启用 ** 候机室 ** 功能。如果此值为 “true”,则 ** 禁用 ** “join_before_host” 设置。
示例值:
false
alternative_hosts
string 
可选
会议的替代主持人电子邮件地址或id的分号分隔列表。
示例值:
jchill@example.com;thill@example.com
alternative_host_update_polls
boolean 
可选
是否启用 ** 允许备用主机添加或编辑轮询 ** 功能。这需要Zoom 5.8.0或更高版本。
示例值:
true
participant_video
boolean 
可选
是否在参与者视频开启的情况下开始会议。
示例值:
false
calendar_type
enum<integer> 
可选
指示用于安排会议的日历集成类型。
'1'-缩放Outlook加载项
'2' - Zoom for Google Workspace附加组件
使用 'private_meeting' 字段来确定是否共享会议的详细信息。
枚举值:
12
示例值:
1
audio
enum<string> 
可选
参与者如何加入会议的音频部分。
'both'-电话和VoIP。
“电话”-仅电话。
'voip'-仅VoIP。
“第三方”-第三方音频会议。
枚举值:
bothtelephonyvoipthirdParty
默认值:
both
示例值:
telephony
in_meeting
boolean 
已废弃
是否在印度 (in) 主办会议。此值默认为 “false”。
默认值:
false
示例值:
false
mute_upon_entry
boolean 
可选
入场时是否将参与者静音。
默认值:
false
示例值:
false
global_dial_in_countries
array[string]
可选
可用的全球拨入国家/地区列表。
join_before_host
boolean 
可选
参与者是否可以在主持人之前加入会议。此字段仅用于预定会议 (“2”) 或定期会议 (“3” 和 “8”)。此值默认为 “false”。
如果启用了 ** 候机室 ** 功能,则此设置为 ** 禁用 **。
默认值:
false
示例值:
false
contact_name
string 
可选
会议注册的联系人姓名。
示例值:
Jill Chill
host_save_video_order
boolean 
可选
是否启用 ** 允许主机保存视频订单 ** 功能。
示例值:
true
cn_meeting
boolean 
已废弃
是否在中国 (CN) 主办会议。此值默认为 “false”。
默认值:
false
示例值:
false
registrants_email_notification
boolean 
可选
是否向注册人发送有关其注册批准、取消或拒绝的电子邮件通知。
“真”-发送电子邮件通知。
'false'-不发送电子邮件通知。
将此值设置为 'true' 也可以使用 'registrants_confirmation_email' 参数。
示例值:
true
watermark
boolean 
可选
查看共享屏幕时是否添加水印。
默认值:
false
示例值:
false
alternative_hosts_email_notification
boolean 
可选
是否向备用主机发送电子邮件通知。此值默认为 “true”。
默认值:
true
示例值:
true
approval_type
enum<integer> 
可选
启用会议注册审批。
“0”-自动批准注册。
'1'-手动批准注册。
'2'-无需注册。
此值默认为 “2”。
枚举值:
012
默认值:
2
示例值:
2
use_pmi
boolean 
可选
是否使用 [个人会议ID (PMI)](/docs/api/rest/using-zoop-apis/# 了解-Personal-Meeting-id-pmi) 而不是生成的会议ID。此字段仅用于计划的会议 ('2') 、即时会议 ('1') 或无固定时间的定期会议 ('3')。此值默认为 “false”。
默认值:
false
示例值:
false
close_registration
boolean 
可选
是否在活动日期后关闭注册。此值默认为 “false”。
默认值:
false
示例值:
false
push_change_to_calendar
boolean 
可选
是否将会议更改推送到日历。
要启用此功能,在Zoom web门户的用户配置文件页面中配置 ** 配置日历和联系人服务 **,并启用 ** 在缩放和集成日历之间双向自动同步缩放日历事件信息。缩放web门户的 ** 设置 ** 页面中的 ** 设置。
'true'-将会议更改推送到日历。
'false'-不要将会议更改推送到日历。
默认值:
false
示例值:
false
resources
array [object {3}] 
会议的资源。
可选
auto_recording
enum<string> 
可选
自动录制设置。
“本地”-在本地记录会议。
'cloud'-将会议记录到云中。
'none'-自动录制已禁用。
此值默认为 “none”。
枚举值:
localcloudnone
默认值:
none
示例值:
cloud
host_video
boolean 
可选
是否开启与主持人的会议视频。
示例值:
true
language_interpretation
object 
可选
会议的 语言口译设置。确保在web门户中添加语言,以便在API中使用它。有关详细信息,请参见链接。
** 注意: ** 此功能仅适用于某些会议加载项,教育,业务和更高的计划。如果未在主持人的帐户上启用此功能,则此设置将 ** 不 ** 应用于会议。
internal_meeting
boolean 
可选
是否将会议设置为内部会议。
默认值:
false
示例值:
false
authentication_exception
array [object {2}] 
可选
可以绕过会议身份验证的参与者列表。这些参与者将收到一个独特的会议邀请。
jbh_time
enum<integer> 
可选
如果 “join_before_host” 字段的值为 “true”,则此字段指示参与者可以在会议主持人之前加入会议的时间限制。
“0”-允许参与者随时加入会议。
'5'-允许参与者在会议开始前5分钟加入。
'10'-允许参与者在会议开始前10分钟加入。
枚举值:
0510
示例值:
0
participant_focused_meeting
boolean 
可选
是否将会议设置为以参与者为焦点的会议。
默认值:
false
示例值:
false
audio_conference_info
string 
可选
第三方音频会议信息。
<= 2048 字符
示例值:
test
authentication_domains
string 
可选
会议的已验证域。只有电子邮件地址包含经过身份验证的域的Zoom用户才能加入会议。逗号分隔多个域或使用通配符列出域。
示例值:
example.com
private_meeting
boolean 
可选
是否将会议设置为私密会议。
示例值:
false
meeting_invitees
array [object {1}] 
会议受邀者名单。
可选
email_notification
boolean 
可选
是否向 [备用主机] 发送电子邮件通知 (https://support.zoom.us/hc/en-us/articles/208220166) 和 具有调度权限的用户。此值默认为 “true”。
默认值:
true
示例值:
true
pre_schedule
boolean 
可选
是否通过 GSuite应用程序 创建预先安排的会议。此 ** 仅 ** 支持会议 “类型” 值 “2” (预定会议) 和 “3” (无固定时间的定期会议)。
'true'-创建预先安排的会议。
'false'-创建一个常规会议。
默认值:
false
示例值:
false
timezone
string 
可选
要分配给 “start_time” 值的时区。此字段仅用于具有固定时间的预定会议或定期会议。
有关支持的时区及其格式的列表,请参阅我们的 [timezone list](/docs/api/rest/other-references/breablation-lists/# timezones)。
示例值:
America/Los_Angeles
default_password
boolean 
可选
是否使用用户的设置生成默认密码。此值默认为 “false”。
如果此值为 “true”,并且用户使用密码启用了PMI设置,则用户的会议将使用PMI密码。它将 ** 不 ** 使用默认密码。
默认值:
false
示例值:
false
schedule_for
string 
可选
要为其安排会议的用户的电子邮件地址或用户ID。
示例值:
jchill@example.com
type
enum<integer> 
可选
会议的类型。
'1'-即时会议。
'2'-预定的会议。
'3'-没有固定时间的定期会议。
'8'-固定时间的定期会议。
枚举值:
1238
默认值:
2
示例值:
2
agenda
string 
可选
会议议程。此值的最大长度为2,000个字符。
<= 2000 字符
示例值:
My Meeting
duration
integer 
可选
会议的预定持续时间 (以分钟为单位)。此字段仅用于计划的会议 (“2”)。
示例值:
60
recurrence
object 
可选
递归对象。此对象仅用于类型为 “8” 的会议,即具有固定时间的定期会议。
end_date_time
string <date-time>
可选
选择会议在取消之前再次举行的最终日期。应该是UTC时间,如2017-11-25 t12: 00:00Z。不能与 “end_times” 一起使用。
示例值:
2022-04-02T15:59:00Z
end_times
integer 
可选
选择会议取消前应重复的次数。循环的最大数量为60。不能与 “end_date_time” 一起使用。
<= 60
默认值:
1
示例值:
7
monthly_week
enum<integer> 
可选
仅当您安排类型为 ** “3” 的定期会议时,才使用此字段 ** 来说明会议应在当月的某周再次发生。如果使用此字段,则还必须使用 “monthly_week_day” 字段来说明会议应在一周中的某一天重新举行。
“-1”-这个月的最后一周。
'1'-该月的第一周。
'2'-这个月的第二周。
'3'-这个月的第三周。
“4”-这个月的第四周。
枚举值:
-11234
示例值:
1
monthly_week_day
enum<integer> 
可选
仅当您安排类型为 “3” 的定期会议时,才使用此字段 **,以说明每月会议应在一周中的特定日期再次发生。要使用此字段,还必须使用 “monthly_week” 字段。
'1'-星期天。
“2”-星期一。
“3”-星期二。
“4”-星期三。
“5”-星期四。
“6”-星期五。
'7'-星期六。
枚举值:
1234567
示例值:
1
repeat_interval
integer 
可选
定义会议重新召开的时间间隔。例如,要安排每两个月重复一次的会议,请将此字段的值设置为 “2”,并将 “类型” 参数的值设置为 “3”。
对于每日会议,您可以设置的最大时间间隔为 '90' 天。对于每周会议,您可以设置的最大时间间隔为 “12” 周。对于每月会议,最多有 “3” 个月。
示例值:
1
monthly_day
integer 
可选
仅当您安排类型为 ** “3” 的定期会议时,才使用此字段 ** 来说明会议应在一个月中的某一天再次发生。值的范围是从1到31。
对于在每个月的23rd重新召开的会议,请提供 “23” 作为此字段的值,并提供 “1” 作为 “repeat_interval” 字段的值。相反,如果您希望会议每三个月重复一次,则在每月的23rd,将 “repeat_interval” 字段的值更改为 “3”。
默认值:
1
示例值:
1
type
enum<integer> 
必需
定期会议类型。
'1'-每天。
“2”-每周。
“3”-每月。
枚举值:
123
示例值:
1
weekly_days
enum<string> 
可选
如果要安排类型为 “2” 的定期会议以说明会议应重复的一周中的日期,则此字段是必需的。
此字段的值可以是字符串格式的 '1' 到 '7' 之间的数字。例如,如果会议应在星期日重新召开,则提供 “1” 作为此字段的值。
** 注意: ** 要将会议设置为在一周中的多天举行,请为此字段提供逗号分隔的值。例如,如果会议应在星期日和星期二重新举行,则提供 “1,3” 作为此字段的值。
'1'-星期天。
“2”-星期一。
“3”-星期二。
“4”-星期三。
“5”-星期四。
“6”-星期五。
'7'-星期六。
枚举值:
1234567
默认值:
1
示例值:
1
start_time
string <date-time>
可选
会议的开始时间。此字段仅用于具有固定时间的预定会议或定期会议。这支持本地时间和GMT格式。
要以GMT格式设置会议的开始时间,请使用 “yyyy-mm-ddthh: MM: ssz” 日期时间格式。例如,'2020-03-31 t12: 02:00Z'。
要使用特定时区设置会议的开始时间,请使用 'yyyy-mm-ddthh: MM: ss' 日期-时间格式,并在 “时区” 字段中指定 [时区ID](/docs/api/rest/others-references/breviation-lists/# timezones)。如果未指定时区,则 “时区” 值默认为Zoom帐户的时区。您也可以使用 'UTC' 的 'timezone' 值。
示例值:
2022-03-25T07:32:55Z
password
string 
可选
加入会议所需的密码。默认情况下,密码最多只能有10个字符,并且只能包含字母数字字符以及 “@” 、 “-” 、 “_” 和 “*” 字符。
如果帐户所有者或管理员已配置 [最低密码要求设置](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords # h_a427384b-e383-4f80-864d-794bf0a37604),则密码 ** 必须 ** 满足这些要求。
如果启用了密码要求,请使用 [** 获取用户设置 ](/docs/api-reference/zoo-api/methods # operation/userSettings) API或 [ 获取账户设置 **](/docs/api-reference/zoom-api/ma # operation/accountSettings) api获取需求。
<= 10 字符
示例值:
123456
tracking_fields
array [object {2}] 
可选
有关会议跟踪字段的信息。
field
string 
跟踪字段的标签。
必需
示例值:
field1
value
string 
跟踪字段的值。
可选
示例值:
value1
topic
string 
会议的主题。
可选
<= 200 字符
示例值:
My Meeting
template_id
string 
可选
用于使用 会议模板 安排会议的帐户管理员会议模板ID。有关帐户管理员提供的会议模板的列表,请使用 [** 列出会议模板 **](/docs/api-reference/zoom-api/methods # operation/listMeetingTemplates) api。
此时,此字段 ** 仅 ** 接受帐户管理员会议模板id。
要启用帐户管理会议模板功能,联系缩放支持。
示例值:
Dv4YdINdTk+Z5RToadh5ug==
示例
{
    "settings": {
        "encryption_type": "enhanced_encryption",
        "authentication_option": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
        "breakout_room": {
            "rooms": [
                {
                    "name": "room1",
                    "participants": [
                        "jchill@example.com"
                    ]
                }
            ],
            "enable": true
        },
        "sign_language_interpretation": {
            "enable": true,
            "interpreters": [
                {
                    "sign_language": "American",
                    "email": "interpreter@example.com"
                }
            ]
        },
        "additional_data_center_regions": [
            "TY"
        ],
        "show_share_button": true,
        "focus_mode": true,
        "registrants_confirmation_email": true,
        "approved_or_denied_countries_or_regions": {
            "method": "approve",
            "enable": true,
            "approved_list": [
                "CX"
            ],
            "denied_list": [
                "CA"
            ]
        },
        "registration_type": 1,
        "contact_email": "jchill@example.com",
        "continuous_meeting_chat": {
            "enable": true,
            "auto_add_invited_external_users": true
        },
        "allow_multiple_devices": true,
        "meeting_authentication": true,
        "waiting_room": false,
        "alternative_hosts": "jchill@example.com;thill@example.com",
        "alternative_host_update_polls": true,
        "participant_video": false,
        "calendar_type": 1,
        "audio": "both",
        "in_meeting": false,
        "mute_upon_entry": false,
        "global_dial_in_countries": [
            "US"
        ],
        "join_before_host": false,
        "contact_name": "Jill Chill",
        "host_save_video_order": true,
        "cn_meeting": false,
        "registrants_email_notification": true,
        "watermark": false,
        "alternative_hosts_email_notification": true,
        "approval_type": 2,
        "use_pmi": false,
        "close_registration": false,
        "push_change_to_calendar": false,
        "resources": [
            {
                "permission_level": "editor",
                "resource_type": "whiteboard",
                "resource_id": "X4Hy02w3QUOdskKofgb9Jg"
            }
        ],
        "auto_recording": "none",
        "host_video": true,
        "language_interpretation": {
            "enable": true,
            "interpreters": [
                {
                    "languages": "US,FR",
                    "email": "interpreter@example.com"
                }
            ]
        },
        "internal_meeting": false,
        "authentication_exception": [
            {
                "name": "Jill Chill",
                "email": "jchill@example.com"
            }
        ],
        "jbh_time": 0,
        "participant_focused_meeting": false,
        "audio_conference_info": "test",
        "authentication_domains": "example.com",
        "private_meeting": false,
        "meeting_invitees": [
            {
                "email": "jchill@example.com"
            }
        ],
        "email_notification": true
    },
    "pre_schedule": false,
    "timezone": "America/Los_Angeles",
    "default_password": false,
    "schedule_for": "jchill@example.com",
    "type": 2,
    "agenda": "My Meeting",
    "duration": 60,
    "recurrence": {
        "end_date_time": "2022-04-02T15:59:00Z",
        "end_times": 1,
        "monthly_week": -1,
        "monthly_week_day": 1,
        "repeat_interval": 1,
        "monthly_day": 1,
        "type": 1,
        "weekly_days": "1"
    },
    "start_time": "2022-03-25T07:32:55Z",
    "password": "123456",
    "tracking_fields": [
        {
            "field": "field1",
            "value": "value1"
        }
    ],
    "topic": "My Meeting",
    "template_id": "Dv4YdINdTk+Z5RToadh5ug=="
}

示例代码

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//users//meetings' \
--header 'Content-Type: application/json' \
--data-raw '{
    "settings": {
        "encryption_type": "enhanced_encryption",
        "authentication_option": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
        "breakout_room": {
            "rooms": [
                {
                    "name": "room1",
                    "participants": [
                        "jchill@example.com"
                    ]
                }
            ],
            "enable": true
        },
        "sign_language_interpretation": {
            "enable": true,
            "interpreters": [
                {
                    "sign_language": "American",
                    "email": "interpreter@example.com"
                }
            ]
        },
        "additional_data_center_regions": [
            "TY"
        ],
        "show_share_button": true,
        "focus_mode": true,
        "registrants_confirmation_email": true,
        "approved_or_denied_countries_or_regions": {
            "method": "approve",
            "enable": true,
            "approved_list": [
                "CX"
            ],
            "denied_list": [
                "CA"
            ]
        },
        "registration_type": 1,
        "contact_email": "jchill@example.com",
        "continuous_meeting_chat": {
            "enable": true,
            "auto_add_invited_external_users": true
        },
        "allow_multiple_devices": true,
        "meeting_authentication": true,
        "waiting_room": false,
        "alternative_hosts": "jchill@example.com;thill@example.com",
        "alternative_host_update_polls": true,
        "participant_video": false,
        "calendar_type": 1,
        "audio": "both",
        "in_meeting": false,
        "mute_upon_entry": false,
        "global_dial_in_countries": [
            "US"
        ],
        "join_before_host": false,
        "contact_name": "Jill Chill",
        "host_save_video_order": true,
        "cn_meeting": false,
        "registrants_email_notification": true,
        "watermark": false,
        "alternative_hosts_email_notification": true,
        "approval_type": 2,
        "use_pmi": false,
        "close_registration": false,
        "push_change_to_calendar": false,
        "resources": [
            {
                "permission_level": "editor",
                "resource_type": "whiteboard",
                "resource_id": "X4Hy02w3QUOdskKofgb9Jg"
            }
        ],
        "auto_recording": "none",
        "host_video": true,
        "language_interpretation": {
            "enable": true,
            "interpreters": [
                {
                    "languages": "US,FR",
                    "email": "interpreter@example.com"
                }
            ]
        },
        "internal_meeting": false,
        "authentication_exception": [
            {
                "name": "Jill Chill",
                "email": "jchill@example.com"
            }
        ],
        "jbh_time": 0,
        "participant_focused_meeting": false,
        "audio_conference_info": "test",
        "authentication_domains": "example.com",
        "private_meeting": false,
        "meeting_invitees": [
            {
                "email": "jchill@example.com"
            }
        ],
        "email_notification": true
    },
    "pre_schedule": false,
    "timezone": "America/Los_Angeles",
    "default_password": false,
    "schedule_for": "jchill@example.com",
    "type": 2,
    "agenda": "My Meeting",
    "duration": 60,
    "recurrence": {
        "end_date_time": "2022-04-02T15:59:00Z",
        "end_times": 1,
        "monthly_week": -1,
        "monthly_week_day": 1,
        "repeat_interval": 1,
        "monthly_day": 1,
        "type": 1,
        "weekly_days": "1"
    },
    "start_time": "2022-03-25T07:32:55Z",
    "password": "123456",
    "tracking_fields": [
        {
            "field": "field1",
            "value": "value1"
        }
    ],
    "topic": "My Meeting",
    "template_id": "Dv4YdINdTk+Z5RToadh5ug=="
}'

返回响应

🟢201** HTTP状态代码: ** '201' 会议已创建。
application/json
Body
会议对象。
occurrences
array [object {4}] 
出现对象的数组。
可选
duration
integer 
持续时间。
可选
示例值:
60
start_time
string <date-time>
开始时间。
可选
示例值:
2022-03-25T07:46:00Z
occurrence_id
string 
可选
发生ID: 标识重复发生的网络研讨会的唯一标识符。定期网络研讨会 最多可以出现50次。
示例值:
1648194360000
status
string 
发生状态。
可选
示例值:
available
settings
object 
会议设置。
可选
breakout_room
object 
可选
设置为 [预先分配分组会议室](https://support.zoom.us/hc/en-us/文章/360032752671-Pre-assigning-participants-to-breakout-rooms # h_36f71353-4190-48a2-b999-ca129861c1f4)。
custom_keys
array [object {2}] 
可选
分配给会议的自定义键和值。
<= 10 items
global_dial_in_numbers
array [object {5}] 
可选
全球拨入国家或地区。
show_share_button
boolean 
可选
在会议注册页面上显示社交共享按钮。
此设置仅适用于需要 注册 的会议。
示例值:
true
registrants_confirmation_email
boolean 
可选
是否向注册人发送电子邮件确认。
“真”-发送确认电子邮件。
'false'-不要发送确认电子邮件。
示例值:
true
approved_or_denied_countries_or_regions
object 
可选
批准或阻止来自特定地区或国家/地区的用户加入此会议。
continuous_meeting_chat
object 
可选
有关 ** 启用连续会议聊天 ** 功能的信息。
allow_multiple_devices
boolean 
可选
允许与会者从多个设备加入会议。此设置仅适用于需要 注册 的会议。
示例值:
true
meeting_authentication
boolean 
可选
“True”-只有经过身份验证的用户才能加入会议。
示例值:
true
alternative_hosts
string 
可选
会议的替代主持人电子邮件地址或id的分号分隔列表。
示例值:
jchill@example.com;thill@example.com
alternative_host_update_polls
boolean 
可选
是否启用 ** 允许备用主机添加或编辑轮询 ** 功能。这需要Zoom 5.8.0或更高版本。
示例值:
true
participant_video
boolean 
可选
在参与者加入会议时启动视频。
示例值:
false
calendar_type
enum<integer> 
可选
用于安排会议的日历集成类型。
'1'-缩放Outlook加载项
'2' - Zoom for Google Workspace附加组件
使用 'private_meeting' 字段来确定是否共享会议的详细信息。
枚举值:
12
示例值:
1
in_meeting
boolean 
在印度举办会议。
已废弃
默认值:
false
示例值:
false
mute_upon_entry
boolean 
可选
入场时将参与者静音。
默认值:
false
示例值:
false
global_dial_in_countries
array[string]
可选
全球拨入国家/地区列表。
join_before_host
boolean 
可选
允许参与者在主持人开始会议之前加入会议。仅用于预定会议或定期会议。
默认值:
false
示例值:
true
host_save_video_order
boolean 
可选
是否启用 ** 允许主机保存视频订单 ** 功能。
示例值:
true
watermark
boolean 
可选
查看共享屏幕时添加水印。
默认值:
false
示例值:
false
approval_type
enum<integer> 
可选
启用注册并为注册设置批准。请注意,此功能要求主机为 ** 许可 ** 用户类型。** 无法为基本用户启用注册。**
“0”-自动批准。
'1'-手动批准。
“2”-无需注册。
枚举值:
012
默认值:
2
示例值:
0
close_registration
boolean 
可选
在事件日期之后关闭注册。
默认值:
false
示例值:
false
push_change_to_calendar
boolean 
可选
是否将会议更改推送到日历。
要启用此功能,在Zoom web门户的用户配置文件页面中配置 ** 配置日历和联系人服务 **,并启用 ** 在缩放和集成日历之间双向自动同步缩放日历事件信息。缩放web门户的 ** 设置 ** 页面中的 ** 设置。
'true'-将会议更改推送到日历。
'false'-不要将会议更改推送到日历。
默认值:
false
示例值:
false
internal_meeting
boolean 
可选
是否将会议设置为内部会议。
默认值:
false
示例值:
false
authentication_exception
array [object {3}] 
可选
此处添加的参与者将收到唯一的会议邀请链接并绕过身份验证。
jbh_time
enum<integer> 
可选
如果 “join_before_host” 字段的值设置为 “true”,则使用此字段指示参与者可以在主持人之前加入会议的时间限制。
“0”-允许参与者随时加入。
'5'-允许参与者在会议开始前5分钟加入。
'10'-允许参与者在会议开始前10分钟加入。
枚举值:
0510
示例值:
0
audio_conference_info
string 
可选
第三方音频会议信息。
<= 2048 字符
示例值:
test
authentication_domains
string 
可选
如果用户配置了 [使用指定域登录缩放](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars # h_5c0df2e1-cfd2-469f-bb4a-c77d7c0cca6f) 选项,这将列出经过身份验证的域。
示例值:
example.com
encryption_type
enum<string> 
可选
在开始或会议时,在增强加密和 端到端加密 之间进行选择。使用端到端加密时,将 ** 自动禁用 ** 一些功能 (例如,云录音,电话/SIP/H.323拨入)。
'enhanced_encryption'-增强加密。如果启用此选项,加密将存储在云中。
“e2ee”-端到端加密。加密密钥存储在您的本地设备中,其他任何人都无法获得。启用此设置还会 ** 禁用 ** 主机前加入、云录制、流式传输、实时转录、分组讨论会议室、轮询、1:1私人聊天和会议反应功能。
枚举值:
enhanced_encryptione2ee
示例值:
enhanced_encryption
authentication_option
string 
可选
会议身份验证选项ID。
示例值:
signIn_D8cJuqWVQ623CI4Q8yQK0Q
sign_language_interpretation
object 
可选
会议的 手语翻译设置。确保在web门户中添加语言,以便在API中使用它。有关详细信息,请参见链接。
** 注意: ** 如果未在主持人的帐户上启用此功能,则此设置将 ** 不 ** 应用于会议。
focus_mode
boolean 
可选
会议开始时是否启用 ** 焦点模式 ** 功能。
示例值:
true
registration_type
enum<integer> 
可选
注册类型。仅用于固定时间的定期会议。
“1”-与会者注册一次,可以参加任何事件。
“2”-与会者需要注册每次出现才能参加。
“3”-与会者注册一次,可以选择一个或多个事件参加。
枚举值:
123
默认值:
1
示例值:
1
contact_email
string 
注册联系人电子邮件
可选
示例值:
jchill@example.com
waiting_room
boolean 
启用等候室。
可选
默认值:
false
示例值:
false
audio
enum<string> 
可选
确定参与者如何加入会议的音频部分。
“两者”-电话和VoIP。
“电话”-仅电话。
'voip'-仅VoIP。
“第三方”-第三方音频会议。
枚举值:
bothtelephonyvoipthirdParty
默认值:
both
示例值:
telephony
authentication_name
string 
可选
在 [认证配置文件] 中设置的认证名称 (https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars # h_5c0df2e1-cfd2-469f-bb4a-c77d7c0cca6f)。
示例值:
Sign in to Zoom
enforce_login_domains
string 
已废弃
只有具有指定域的登录用户才能加入会议。
** 此字段已弃用,以后将不再支持。**
作为替代,请使用 'meeting_authentication' 、 'authentication_option' 和 'authentication_domains' 字段了解 认证配置 为会议设置。
示例值:
example.com
contact_name
string 
注册联系人姓名
可选
示例值:
Jill Chill
cn_meeting
boolean 
在中国举办会议。
已废弃
默认值:
false
示例值:
false
registrants_email_notification
boolean 
可选
是否向注册人发送有关其注册批准、取消或拒绝的电子邮件通知。
“真”-发送电子邮件通知。
'false'-不发送电子邮件通知。
将此值设置为 'true' 也可以使用 'registrants_confirmation_email' 参数。
示例值:
true
alternative_hosts_email_notification
boolean 
可选
标志来确定是否向备用主机发送电子邮件通知,默认值为true。
默认值:
true
示例值:
true
use_pmi
boolean 
可选
使用 [个人会议ID (PMI)](/docs/api/rest/using-zoop-api/# 理解-个人会议id-pmi)。仅用于计划的会议和没有固定时间的定期会议。
默认值:
false
示例值:
false
resources
array [object {3}] 
会议的资源。
可选
auto_recording
enum<string> 
可选
自动录制。
“本地”-记录在本地。
“云”-记录在云端。
'none'-已禁用。
枚举值:
localcloudnone
默认值:
none
示例值:
cloud
host_video
boolean 
可选
主持人加入会议时启动视频。
示例值:
true
language_interpretation
object 
可选
会议的 语言口译设置。确保在web门户中添加语言,以便在API中使用它。有关详细信息,请参见链接。
** 注意: ** 此功能仅适用于某些会议加载项,教育,业务和更高的计划。如果未在主持人的帐户上启用此功能,则此设置将 ** 不 ** 应用于会议。
enforce_login
boolean 
已废弃
只有已登录的用户才能加入此会议。
** 此字段已弃用,以后将不再支持。**
作为替代,请使用 'meeting_authentication' 、 'authentication_option' 和 'authentication_domains' 字段了解 认证配置 为会议设置。
示例值:
true
participant_focused_meeting
boolean 
可选
是否将会议设置为以参与者为焦点的会议。
默认值:
false
示例值:
false
private_meeting
boolean 
可选
会议是否设置为私密会议。
示例值:
false
email_notification
boolean 
可选
是否向 [备用主机] 发送电子邮件通知 (https://support.zoom.us/hc/en-us/articles/208220166) 和 具有调度权限的用户。此值默认为 “true”。
默认值:
true
示例值:
true
registration_url
string 
可选
注册人可用于注册会议的URL。仅对已启用注册的会议返回此字段。
示例值:
https://example.com/meeting/register/7ksAkRCoEpt1Jm0wa-E6lICLur9e7Lde5oW6
join_url
string 
可选
参与者加入会议的URL。此URL只应与您要邀请参加会议的用户共享。
示例值:
https://example.com/j/11111
chat_join_url
string 
加入聊天的URL。
可选
示例值:
https://example.com/launch/jc/11111
assistant_id
string 
可选
代表主持人安排此会议的用户的ID。
示例值:
kFFvsJc-Q1OSxaJQLvaa_A
pre_schedule
boolean 
可选
预先安排的会议是否通过 GSuite应用程序 创建。这仅支持 “2” (预定会议) 和 “3” (没有固定时间的定期会议) 的会议 “类型” 值。
'true'-GSuite预先安排的会议。
“假”-例行会议。
默认值:
false
示例值:
false
timezone
string 
可选
要格式化 “start_time” 的时区。
示例值:
America/Los_Angeles
start_url
string 
可选
开始会议的URL。此URL只应由会议的主持人使用,并且 ** 不应与会议的主持人 ** 以外的任何人共享,因为具有此URL的任何人都可以作为会议的主持人登录到Zoom客户端。
示例值:
https://example.com/s/11111
created_at
string <date-time>
可选
创建此会议的日期和时间。
示例值:
2022-03-25T07:29:29Z
type
enum<integer> 
会议类型。
可选
枚举值:
1238
默认值:
2
示例值:
2
agenda
string 
议程
可选
示例值:
My Meeting
pmi
string 
可选
[个人会议ID (PMI)](/docs/api/rest/using-zoom-api/# 了解-个人会议id-pmi)。仅用于计划的会议和没有固定时间的定期会议。
示例值:
97891943927
duration
integer 
会议持续时间。
可选
示例值:
60
recurrence
object 
可选
递归对象。此对象仅用于类型为 “8” 的会议,即固定时间的定期会议。
end_date_time
string <date-time>
可选
选择会议在取消之前再次举行的最终日期。应该是UTC时间,如2017-11-25 t12: 00:00Z。不能与 “end_times” 一起使用。
示例值:
2022-04-02T15:59:00Z
end_times
integer 
可选
选择会议取消前应重复的次数。循环的最大数量为60。不能与 “end_date_time” 一起使用。
<= 60
默认值:
1
示例值:
7
monthly_week
enum<integer> 
可选
仅当您安排类型为 ** “3” 的定期会议时,才使用此字段 ** 来说明会议应在当月的某周再次发生。如果使用此字段,则还必须使用 “monthly_week_day” 字段来说明会议应在一周中的某一天重新举行。
“-1”-这个月的最后一周。
'1'-该月的第一周。
'2'-这个月的第二周。
'3'-这个月的第三周。
“4”-这个月的第四周。
枚举值:
-11234
示例值:
1
monthly_week_day
enum<integer> 
可选
仅当您安排类型为 “3” 的定期会议时,才使用此字段 **,以说明每月会议应在一周中的特定日期再次发生。要使用此字段,还必须使用 “monthly_week” 字段。
'1'-星期天。
“2”-星期一。
“3”-星期二。
“4”-星期三。
“5”-星期四。
“6”-星期五。
'7'-星期六。
枚举值:
1234567
示例值:
1
repeat_interval
integer 
可选
定义会议再次发生的时间间隔。例如,要安排每两个月重复一次的会议,请将此字段的值设置为 “2”,并将 “类型” 参数的值设置为 “3”。
对于每日会议,您可以设置的最大时间间隔为 '90' 天。对于每周会议,您可以设置的最大时间间隔为 “12” 周。对于每月会议,最多有 “3” 个月。
示例值:
1
monthly_day
integer 
可选
仅当您安排类型为 “3” 的定期会议时,才使用此字段,以说明会议应在一个月内重复的日期。值的范围是从1到31。
例如,如果您希望会议在每个月的23rd再次发生,请提供 “23” 作为此字段的值,并提供 “1” 作为 “repeat_interval” 字段的值。相反,要使会议每三个月在该月的23rd重新出现一次,请将 “repeat_interval” 字段的值更改为 “3”。
默认值:
1
示例值:
1
type
enum<integer> 
必需
定期会议类型。
'1'-每天。
“2”-每周。
“3”-每月。
枚举值:
123
示例值:
1
weekly_days
enum<string> 
可选
此字段是必需的 ** 如果您正在安排类型为 ** “2” 的定期会议,以说明会议应重复的一周中的日期。
此字段的值可以是字符串格式的 '1' 到 '7' 之间的数字。例如,如果会议应在星期日重新召开,则提供 “1” 作为此字段的值。
** 注意: ** 如果您希望会议在一周中的多天举行,请为此字段提供逗号分隔的值。例如,如果会议应在星期日和星期二重新举行,则提供 “1,3” 作为此字段的值。
'1'-星期天。
“2”-星期一。
“3”-星期二。
“4”-星期三。
“5”-星期四。
“6”-星期五。
'7'-星期六。
枚举值:
1234567
默认值:
1
示例值:
1
start_time
string <date-time>
可选
会议开始日期-时间 (UTC/GMT),例如 “2020-03-31 t12: 02:00Z'。
示例值:
2022-03-25T07:29:29Z
password
string 
可选
会议密码。此密码只能包含以下字符: '[a-z A-Z 0-9 @ - _ * !]'
如果 ** 在安排新会议时需要密码 ** 为用户启用了设置并且 [locked](https://support.zoom.us/hc/en-us/articles/115005269866-Using-Tiered-Settings # locked),密码字段将在响应中自动生成,即使API请求中未提供该字段。
示例值:
123456
tracking_fields
array [object {3}] 
跟踪字段。
可选
visible
boolean 
可选
指示 跟踪字段 在缩放Web门户的会议安排选项中是否可见。
“True”: 跟踪字段可见。
“False”: 用户在Zoom Web门户的会议选项中看不到跟踪字段,但在通过API安排此会议时使用了该字段。用户只能在通过API安排会议时使用不可见的跟踪字段。
示例值:
true
field
string 
跟踪字段的标签。
可选
示例值:
field1
value
string 
跟踪字段的值。
可选
示例值:
value1
h323_password
string 
可选
H.323/SIP机房系统密码
示例值:
123456
topic
string 
会议主题。
可选
<= 200 字符
示例值:
My Meeting
id
integer <int64>
可选
会议ID: 会议的唯一标识符,格式为 ** long ** (在JSON中表示为int64数据类型)。也称为会议编号。
示例值:
92674392836
host_email
string <email>
可选
会议主持人的电子邮件地址。
示例值:
jchill@example.com
示例
{
    "occurrences": [
        {
            "duration": 60,
            "start_time": "2022-03-25T07:46:00Z",
            "occurrence_id": "1648194360000",
            "status": "available"
        }
    ],
    "settings": {
        "breakout_room": {
            "rooms": [
                {
                    "name": "room1",
                    "participants": [
                        "jchill@example.com"
                    ]
                }
            ],
            "enable": true
        },
        "custom_keys": [
            {
                "value": "value1",
                "key": "key1"
            }
        ],
        "global_dial_in_numbers": [
            {
                "country": "US",
                "number": "+1 1000200200",
                "city": "New York",
                "country_name": "US",
                "type": "toll"
            }
        ],
        "show_share_button": true,
        "registrants_confirmation_email": true,
        "approved_or_denied_countries_or_regions": {
            "method": "approve",
            "enable": true,
            "approved_list": [
                "CX"
            ],
            "denied_list": [
                "CA"
            ]
        },
        "continuous_meeting_chat": {
            "enable": true,
            "auto_add_invited_external_users": true
        },
        "allow_multiple_devices": true,
        "meeting_authentication": true,
        "alternative_hosts": "jchill@example.com;thill@example.com",
        "alternative_host_update_polls": true,
        "participant_video": false,
        "calendar_type": 1,
        "in_meeting": false,
        "mute_upon_entry": false,
        "global_dial_in_countries": [
            "US"
        ],
        "join_before_host": false,
        "host_save_video_order": true,
        "watermark": false,
        "approval_type": 2,
        "close_registration": false,
        "push_change_to_calendar": false,
        "internal_meeting": false,
        "authentication_exception": [
            {
                "join_url": "https://example.com/s/11111",
                "name": "Jill Chill",
                "email": "jchill@example.com"
            }
        ],
        "jbh_time": 0,
        "audio_conference_info": "test",
        "authentication_domains": "example.com",
        "encryption_type": "enhanced_encryption",
        "authentication_option": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
        "sign_language_interpretation": {
            "enable": true,
            "interpreters": [
                {
                    "sign_language": "American",
                    "email": "interpreter@example.com"
                }
            ]
        },
        "focus_mode": true,
        "registration_type": 1,
        "contact_email": "jchill@example.com",
        "waiting_room": false,
        "audio": "both",
        "authentication_name": "Sign in to Zoom",
        "enforce_login_domains": "example.com",
        "contact_name": "Jill Chill",
        "cn_meeting": false,
        "registrants_email_notification": true,
        "alternative_hosts_email_notification": true,
        "use_pmi": false,
        "resources": [
            {
                "permission_level": "editor",
                "resource_type": "whiteboard",
                "resource_id": "X4Hy02w3QUOdskKofgb9Jg"
            }
        ],
        "auto_recording": "none",
        "host_video": true,
        "language_interpretation": {
            "enable": true,
            "interpreters": [
                {
                    "languages": "US,FR",
                    "email": "interpreter@example.com"
                }
            ]
        },
        "enforce_login": true,
        "participant_focused_meeting": false,
        "private_meeting": false,
        "email_notification": true
    },
    "registration_url": "https://example.com/meeting/register/7ksAkRCoEpt1Jm0wa-E6lICLur9e7Lde5oW6",
    "join_url": "https://example.com/j/11111",
    "chat_join_url": "https://example.com/launch/jc/11111",
    "assistant_id": "kFFvsJc-Q1OSxaJQLvaa_A",
    "pre_schedule": false,
    "timezone": "America/Los_Angeles",
    "start_url": "https://example.com/s/11111",
    "created_at": "2022-03-25T07:29:29Z",
    "type": 2,
    "agenda": "My Meeting",
    "pmi": "97891943927",
    "duration": 60,
    "recurrence": {
        "end_date_time": "2022-04-02T15:59:00Z",
        "end_times": 1,
        "monthly_week": -1,
        "monthly_week_day": 1,
        "repeat_interval": 1,
        "monthly_day": 1,
        "type": 1,
        "weekly_days": "1"
    },
    "start_time": "2022-03-25T07:29:29Z",
    "password": "123456",
    "tracking_fields": [
        {
            "visible": true,
            "field": "field1",
            "value": "value1"
        }
    ],
    "h323_password": "123456",
    "topic": "My Meeting",
    "id": 92674392836,
    "host_email": "jchill@example.com"
}
🟠400** HTTP状态代码: ** '400' <br> 错误的请求 ** 错误码: ** '3000' <br> * 即时会议不支持schedule_for参数; 不能为其他用户安排即时会议。<br> * “{0}” 中的用户已被阻止加入会议和网络研讨会。若要取消阻止,请转到Zoom web门户中的 “设置” 页面,并更新 “阻止特定域中的用户加入会议和网络研讨会”。<br> * 您无法为 {0} 安排会议。<br> ** 错误代码: ** '3161' <br> 您的用户帐户不允许使用会议托管和日程安排
🟠404** HTTP状态代码: ** '404' <br> 未找到 ** 错误代码: ** '1001' <br> 用户 {userId} 不存在或不属于此帐户。<br>
🟠429** HTTP状态代码: ** '429' <br> 请求太多

扫码加 ZOOM 开发者 微信交流

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

扫码加入交流群
上一页
获取livestream详细信息
下一页
列出会议
Built with