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

更新会议

PATCH
/accounts/{accountId}/meetings/{meetingId}
更新会议详细信息。
** 注 **
此API的速率限制为 ** 每天100个请求 **。您可以在24小时内最多更新一次会议 ** 100次。
'start_time' 值 ** 必须 ** 是将来的日期。如果省略该值或过去的日期,则API会忽略此值,并且不会 ** 更新任何定期会议。
Recurrence' 对象是 ** 必需的 **。
** 范围: ** 'meeting:master'
** [速率限制标签](https://marketplace.zoom.us/docs/api-reference/Rate-limits # 速率限制):** 'LIGHT'

请求参数

Path 参数

Query 参数

Body 参数application/json

示例
{
    "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,
        "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",
        "meeting_invitees": [
            {
                "email": "jchil@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
    },
    "pre_schedule": false,
    "timezone": "America/Los_Angeles",
    "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:29:29Z",
    "password": "123456",
    "tracking_fields": [
        {
            "field": "field1",
            "value": "value1"
        }
    ],
    "topic": "My Meeting",
    "template_id": "5Cj3ceXoStO6TGOVvIOVPA=="
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'http://prod-cn.your-api-server.com/accounts//meetings/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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,
        "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",
        "meeting_invitees": [
            {
                "email": "jchil@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
    },
    "pre_schedule": false,
    "timezone": "America/Los_Angeles",
    "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:29:29Z",
    "password": "123456",
    "tracking_fields": [
        {
            "field": "field1",
            "value": "value1"
        }
    ],
    "topic": "My Meeting",
    "template_id": "5Cj3ceXoStO6TGOVvIOVPA=="
}'

返回响应

🟢204** HTTP状态代码: ** '204' 会议已更新。
application/json
Body

示例
{}
🟠400** HTTP状态代码: ** '400' <br> 错误的请求 ** 错误代码: ** '1010' <br> 在该帐户上找不到用户: {accountId} <br> ** 错误码: ** '3000' <br> 无法访问会议信息。<br> ** 错误代码: ** '3003' <br> 您不是会议主持人。<br> ** 错误码: ** '3000' <br> * 即时会议不支持 “schedule_for” 参数。您无法为其他用户安排即时会议。 * 已阻止 “{0}” 中的用户加入会议和网络研讨会
🟠404** HTTP状态代码: ** '404' <br> 未找到 ** 错误代码: ** '1001' <br> 用户不存在: {userId}。<br> ** 错误代码: ** '3001' <br> 具有此 {meetingId} 的会议未找到或已过期。<br>
🟠429** HTTP状态代码: ** '429' <br> 请求太多

扫码加 ZOOM 开发者 微信交流

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

扫码加入交流群
修改于 2023-10-31 06:13:33
上一页
执行批量轮询创建
下一页
得到一个会议
Built with