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}/meetings/{meetingId}/registrants
Meetings
创建并提交用户对会议的注册。有关如何设置这些字段的要求的详细信息,请参阅 自定义网络研讨会注册。请注意,每个会议的最大注册人数限制为4,999人,如果达到会议的容量,用户将看到错误。
** 先决条件: **
主机必须是 ** 许可 ** 用户类型。
** 范围: ** 'meeting:master'
** [速率限制标签](https://marketplace.zoom.us/docs/api-reference/Rate-limits # 速率限制):** 'Light'

请求参数

Path 参数
meetingId
integer 
必需
会议的ID。
在数据库中存储此值时,必须将其存储为长格式整数,而不是整数。会议id可以超过10位数。
accountId
string 
帐户的唯一标识符。
必需
Query 参数
occurrence_ids
string 
可选
会议发生id的逗号分隔列表。您可以使用 [get a meeting](/docs/api-reference/zoom-api/方法 # operation/meeting) api获取此值。
Body 参数application/json
有关会议注册人的信息。
zip
string 
注册人的邮政编码。
可选
示例值:
94045
country
string 
可选
注册人的两个字母 [国家代码](https://marketplace.zoom.us/docs/api参考/其他参考/缩写-列出 # 国家)。
示例值:
US
custom_questions
array [object {2}] 
可选
有关自定义问题的信息。
title
string 
自定义问题的标题。
可选
示例值:
What do you hope to learn from this?
value
string 
可选
自定义问题的响应值。这有128个字符的限制。
<= 128 字符
示例值:
Look forward to learning how you come up with new recipes and what other services you offer.
purchasing_time_frame
enum<string> 
可选
注册人的购买时间范围:
“一个月内”
'1-3个月'
'4-6个月'
“超过6个月”
'无时间帧'
枚举值:
Within a month1-3 months4-6 monthsMore than 6 monthsNo timeframe
示例值:
1-3 months
address
string 
注册人的地址。
可选
示例值:
1800 Amphibious Blvd.
comments
string 
可选
注册人的问题和评论。
示例值:
Looking forward to the discussion.
city
string 
注册人的城市。
可选
示例值:
Mountain View
org
string 
注册人的组织。
可选
示例值:
Cooking Org
last_name
string 
注册人的姓氏。
可选
<= 64 字符
示例值:
Chill
no_of_employees
enum<string> 
可选
注册人的员工人数:
'1-20'
'21-50'
'51-100'
'101-500'
'500-1,000'
'1,001-5,000'
'5,001-10,000'
“超过10,000”
枚举值:
1-2021-5051-100101-500500-1,0001,001-5,0005,001-10,000More than 10,000
示例值:
1-20
industry
string 
注册人的行业。
可选
示例值:
Food
language
enum<string> 
可选
注册人对确认电子邮件的语言偏好:
'en-US'-英语 (美国)
“de-de”-德语 (德国)
“Es-es”-西班牙语 (西班牙)
“Fr-fr”-法语 (法国)
'Jp-jp'-日语
“Pt-pt”-葡萄牙语 (葡萄牙)
'Ru-ru'-俄语
'Zh-cn'-中文 (中华人民共和国)
'Zh-tw'-中文 (台湾)
'Ko-ko'-韩语
“it-it”-意大利语 (意大利)
“vi-vn”-越南语
'pl-pl'-波兰语
'Tr-tr'-土耳其语
枚举值:
en-USde-DEes-ESfr-FRjp-JPpt-PTru-RUzh-CNzh-TWko-KOit-ITvi-VNpl-PLTr-TR
示例值:
en-US
auto_approve
boolean 
可选
如果安排会议的 “approval_type” 字段值为 “1” (手动批准),但您希望自动批准会议注册人,请将此字段的值设置为 “true”。
** 注意: ** 不能使用此字段更改 “approval_type” 字段值为 “0” (自动批准) 的原定会议的批准设置。
示例值:
true
phone
string 
注册人的电话号码。
可选
示例值:
5550100
role_in_purchase_process
enum<string> 
可选
注册人在购买过程中的角色:
“决策者”
“评估者/推荐者”
'影响者'
'不参与'
枚举值:
Decision MakerEvaluator/RecommenderInfluencerNot involved
示例值:
Influencer
state
string 
注册人的州或省。
可选
示例值:
CA
first_name
string 
注册人的名字。
必需
<= 64 字符
示例值:
Jill
job_title
string 
注册人的职称。
可选
示例值:
Chef
email
string <email>
必需
注册人的电子邮件地址。
<= 128 字符
示例值:
jchill@example.com
示例
{
    "zip": "94045",
    "country": "US",
    "custom_questions": [
        {
            "title": "What do you hope to learn from this?",
            "value": "Look forward to learning how you come up with new recipes and what other services you offer."
        }
    ],
    "purchasing_time_frame": "",
    "address": "1800 Amphibious Blvd.",
    "comments": "Looking forward to the discussion.",
    "city": "Mountain View",
    "org": "Cooking Org",
    "last_name": "Chill",
    "no_of_employees": "",
    "industry": "Food",
    "language": "en-US",
    "auto_approve": true,
    "phone": "5550100",
    "role_in_purchase_process": "",
    "state": "CA",
    "first_name": "Jill",
    "job_title": "Chef",
    "email": "jchill@example.com"
}

示例代码

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//meetings//registrants' \
--header 'Content-Type: application/json' \
--data-raw '{
    "zip": "94045",
    "country": "US",
    "custom_questions": [
        {
            "title": "What do you hope to learn from this?",
            "value": "Look forward to learning how you come up with new recipes and what other services you offer."
        }
    ],
    "purchasing_time_frame": "",
    "address": "1800 Amphibious Blvd.",
    "comments": "Looking forward to the discussion.",
    "city": "Mountain View",
    "org": "Cooking Org",
    "last_name": "Chill",
    "no_of_employees": "",
    "industry": "Food",
    "language": "en-US",
    "auto_approve": true,
    "phone": "5550100",
    "role_in_purchase_process": "",
    "state": "CA",
    "first_name": "Jill",
    "job_title": "Chef",
    "email": "jchill@example.com"
}'

返回响应

🟢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
start_time
string <date-time>
会议的开始时间。
可选
示例值:
2021-07-13T21:44:51Z
join_url
string 
可选
注册者可用于加入会议的URL。
如果会议是 [created](/docs/api-reference/zoom-API/methops # operation/meetingCreate),api将不会返回此字段 “approval_type” 字段值为 “1” (手动批准)。
示例值:
https://example.com/j/11111
participant_pin_code
integer <int64>
可选
参与者PIN码用于在音频参与者加入会议之前对其进行身份验证。
示例值:
380303
registrant_id
string 
注册人的身份证。
可选
示例值:
fdgsfh2ey82fuh
topic
string 
会议的主题。
可选
<= 200 字符
示例值:
My Meeting
id
integer <int64>
会议ID。
可选
示例值:
85746065
示例
{
    "occurrences": [
        {
            "duration": 60,
            "start_time": "2022-03-25T07:46:00Z",
            "occurrence_id": "1648194360000",
            "status": "available"
        }
    ],
    "start_time": "2021-07-13T21:44:51Z",
    "join_url": "https://example.com/j/11111",
    "participant_pin_code": 380303,
    "registrant_id": "fdgsfh2ey82fuh",
    "topic": "My Meeting",
    "id": 85746065
}
🟠400** HTTP状态代码: ** '400' <br> 错误的请求 ** 错误代码: ** '1010' <br> 用户不属于此帐户: {accountId} ** 错误代码: ** '3003' <br> 您不是会议主持人。 ** 错误代码: ** '3043' <br> 会议已达到最大与会者容量。 ** 错误码: ** '3000' <br> 无法访问会议信息。 ** 错误代码: ** '3161' <br> 您的用户帐户不允许使用会议托管和日程安排功能。
🟠404** HTTP状态代码: ** '404' <br> 未找到 ** 错误代码: ** '1001' <br> 会议主持人不存在: {userId}

扫码加 ZOOM 开发者 微信交流

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

扫码加入交流群
上一页
更新实时流状态
下一页
列出会议注册人
Built with