Zoom API 中文版
  1. Groups
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
    • 更新群组的设置
      PATCH
    • 获取组的设置
      GET
    • 创建组
      POST
    • 列表组
      GET
    • 添加组管理员
      POST
    • 列表组管理员
      GET
    • 添加组成员
      POST
    • 列出组成员
      GET
    • 更新小组的网络研讨会注册设置
      PATCH
    • 获取小组的网络研讨会注册设置
      GET
    • 上传虚拟后台文件
      POST
    • 删除虚拟背景文件
      DELETE
    • 删除组管理员
      DELETE
    • 更新锁定设置
      PATCH
    • 获取锁定设置
      GET
    • 更新组成员
      PATCH
    • 删除组成员
      DELETE
    • 更新群组
      PATCH
    • 获取一个组
      GET
    • 删除群组
      DELETE
  • 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. Groups

获取组的设置

GET
/accounts/{accountId}/groups/{groupId}/settings
Groups
获取 [组] 的设置 (https://support.zoom.us/hc/en-us/articles/204519819-组-管理-)。
** 先决条件 **: 专业、商业或教育帐户
** 范围: ** 'group:master'
** [速率限制标签](https://marketplace.zoom.us/docs/api-reference/Rate-limits # 速率限制):** 'MEDIUM'

请求参数

Path 参数
groupId
string 
必需
accountId
string 
帐户的唯一标识符。
必需
Query 参数
option
string 
可选
可选查询参数。
'meeting_authentication'-查看应用于用户帐户的 会议身份验证设置。
'recording_authentication'-查看应用到用户帐户的 录制身份验证设置。
'meeting_security'-查看应用于用户帐户的会议安全设置。
custom_query_fields
string 
可选
提供要用来筛选响应的字段的名称。例如,如果您提供 'host_video' 作为此字段的值,您将得到类似于以下内容的响应:
{
'schedule_meeting': {
'host_video': false
}
}
您可以通过用逗号分隔来提供多个值 (例如: 'host_video,participant_video')。

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://prod-cn.your-api-server.com/accounts//groups//settings'

返回响应

🟢200** 错误代码 **: '200' 仅适用于付费帐户。 ** HTTP状态代码 **: '200' 组设置已返回。
application/json
Body
可选
One of
schedule_meeting
object 
可选
telephony
object 
可选
chat
object 
帐户的聊天设置。
可选
profile
object 
配置文件
可选
recording
object 
可选
audio_conferencing
object 
组的音频会议设置。
可选
in_meeting
object 
可选
email_notification
object 
可选
other_options
object 
可选
示例
{
    "schedule_meeting": {
        "require_password_for_scheduled_meetings": true,
        "join_before_host": true,
        "personal_meeting": true,
        "force_pmi_jbh_password": true,
        "host_video": true,
        "upcoming_meeting_reminder": true,
        "require_password_for_pmi_meetings": "all",
        "always_display_zoom_webinar_as_topic": {
            "enable": false,
            "display_topic_for_scheduled_webinars": false
        },
        "continuous_meeting_chat": {
            "can_add_external_users": true,
            "enable": true,
            "auto_add_invited_external_users": true
        },
        "require_password_for_instant_meetings": true,
        "embed_password_in_join_link": true,
        "use_pmi_for_instant_meetings": true,
        "participant_video": true,
        "use_pmi_for_schedule_meetings": true,
        "audio_type": "both",
        "pstn_password_protected": true,
        "always_display_zoom_meeting_as_topic": {
            "enable": false,
            "display_topic_for_scheduled_meetings": false
        },
        "mute_upon_entry": true,
        "require_password_for_scheduling_new_meetings": true
    },
    "telephony": {
        "third_party_audio": true,
        "audio_conference_info": "test",
        "telephony_regions": {
            "selection_values": "CNTB"
        }
    },
    "chat": {
        "translate_messages": true,
        "search_and_send_animated_gif_images": {
            "enable": true
        },
        "create_private_channels": true,
        "schedule_meetings_in_chat": true,
        "chat_emojis": {
            "enable": true,
            "emojis_option": "all"
        },
        "record_video_messages": true,
        "chat_etiquette_tool": {
            "enable": true,
            "policies": [
                {
                    "is_locked": true,
                    "keywords": [
                        "key"
                    ],
                    "regular_expression": "^test",
                    "trigger_action": 1,
                    "name": "The policy name",
                    "description": "The policy's description",
                    "id": "dvgerwe98z8v9vgbug43iubkjn",
                    "status": "activated"
                }
            ]
        },
        "send_data_to_third_party_archiving_service": {
            "enable": true
        },
        "share_files": {
            "share_option": "anyone",
            "enable": true
        },
        "record_voice_messages": true,
        "create_public_channels": true,
        "allow_users_to_add_contacts": {
            "enable": true,
            "selected_option": 1,
            "user_email_addresses": "123@test.com"
        },
        "allow_users_to_chat_with_others": {
            "enable": true,
            "selected_option": 1,
            "user_email_addresses": "123@test.com"
        },
        "set_retention_period_in_local": {
            "retention_period_of_direct_messages_and_group_conversation": "2m",
            "enable": true,
            "retention_period_of_channels": "2m"
        },
        "screen_capture": true,
        "allow_users_to_search_others_options": "1,3",
        "set_retention_period_in_cloud": {
            "retention_period_of_direct_messages_and_group_conversation": "2m",
            "enable": true,
            "retention_period_of_channels": "2m"
        },
        "share_links_in_chat": true
    },
    "profile": {
        "recording_storage_location": {
            "allowed_values": [
                "US"
            ],
            "value": "US"
        }
    },
    "recording": {
        "host_delete_cloud_recording": true,
        "recording_audio_transcript": true,
        "save_chat_text": true,
        "record_files_separately": {
            "active_speaker": true,
            "gallery_view": true,
            "shared_screen": true
        },
        "recording_thumbnails": true,
        "save_panelist_chat": true,
        "account_user_access_recording": true,
        "recording_highlight": true,
        "record_speaker_view": true,
        "record_audio_file": true,
        "ip_address_access_control": {
            "enable": true,
            "ip_addresses_or_ranges": "200.181.108.17 - 220.181.108.157"
        },
        "save_close_caption": true,
        "optimize_recording_for_3rd_party_video_editor": true,
        "cloud_recording": true,
        "smart_recording": {
            "create_recording_highlights": true,
            "create_smart_chapters": true,
            "create_next_steps": true
        },
        "cloud_recording_download": true,
        "show_timestamp": true,
        "archive": {
            "settings": {
                "cc_transcript_file": true,
                "archive_retention": 1,
                "action_when_archive_failed": 1,
                "chat_with_sender_email": true,
                "audio_file": true,
                "chat_with_direct_message": true,
                "notification_when_archiving_starts": "participants",
                "chat_file": true,
                "video_file": true,
                "play_voice_prompt_when_archiving_starts": "participants"
            },
            "enable": true,
            "type": 1
        },
        "auto_recording": "local",
        "display_participant_name": true,
        "cloud_recording_download_host": true,
        "save_poll_results": true,
        "local_recording": true,
        "record_gallery_view": true,
        "prevent_host_access_recording": true
    },
    "audio_conferencing": {
        "toll_free_and_fee_based_toll_call": {
            "enable": true,
            "numbers": [
                {
                    "country_code": "CN",
                    "number": "7777 777",
                    "code": "86",
                    "country_name": "China",
                    "display_number": "+86 7777 777"
                }
            ],
            "allow_webinar_attendees_dial": true
        }
    },
    "in_meeting": {
        "webinar_polling": {
            "allow_alternative_host_to_add_edit": true,
            "enable": true,
            "require_answers_to_be_anonymous": true,
            "allow_host_to_upload_image": true,
            "manage_saved_polls_and_quizzes": true,
            "advanced_polls": true
        },
        "breakout_room": true,
        "meeting_question_answer": true,
        "disable_screen_sharing_for_in_meeting_guests": true,
        "join_from_desktop": true,
        "allow_participants_chat_with": 1,
        "file_transfer": true,
        "polling": true,
        "show_device_list": true,
        "screen_sharing": true,
        "manual_captioning": {
            "full_transcript": true,
            "auto_generated_captions": true,
            "third_party_captioning_service": true,
            "save_captions": true,
            "manual_captions": true,
            "allow_to_type": true
        },
        "attendee_on_hold": false,
        "feedback": true,
        "closed_caption": true,
        "group_hd": true,
        "meeting_survey": true,
        "join_from_mobile": true,
        "custom_service_instructions": "The specific instructions",
        "allow_users_save_chats": 1,
        "non_verbal_feedback": true,
        "record_play_own_voice": true,
        "post_meeting_feedback": true,
        "remote_control": true,
        "auto_saving_chat": true,
        "entry_exit_chime": "all",
        "private_chat": true,
        "webinar_group_hd": true,
        "meeting_reactions": true,
        "sign_language_interpretation": {
            "languages": [
                "American"
            ],
            "custom_languages": [
                "Language1"
            ],
            "enable": true,
            "enable_sign_language_interpretation_by_default": true
        },
        "webinar_question_answer": true,
        "co_host": true,
        "request_permission_to_unmute": true,
        "use_html_format_email": true,
        "whiteboard": true,
        "workplace_by_facebook": true,
        "show_browser_join_link": true,
        "virtual_background": true,
        "waiting_room": true,
        "virtual_background_settings": {
            "enable": true,
            "files": [
                {
                    "size": 1435,
                    "name": "File name",
                    "id": "fawegw4tq43t35h4nhgfnethswe",
                    "is_default": true,
                    "type": "image"
                }
            ],
            "allow_upload_custom": true,
            "allow_videos": true
        },
        "auto_generated_translation": {
            "language_item_pairList": {
                "all": true,
                "trans_lang_config": [
                    {
                        "speak_language": {
                            "code": "zh",
                            "name": "Chinese (Simplified)"
                        },
                        "translate_to": {
                            "all": true,
                            "language_config": [
                                {
                                    "code": "en",
                                    "name": "English"
                                }
                            ]
                        }
                    }
                ]
            },
            "enable": true
        },
        "who_can_share_screen": "host",
        "auto_answer": true,
        "allow_show_zoom_windows": true,
        "custom_data_center_regions": true,
        "live_streaming_facebook": true,
        "custom_live_streaming_service": true,
        "remote_support": true,
        "slide_control": true,
        "annotation": true,
        "data_center_regions": [
            "AU"
        ],
        "original_audio": true,
        "webinar_survey": true,
        "webinar_chat": {
            "allow_auto_save_local_chat_file": true,
            "allow_panelists_chat_with": 1,
            "allow_attendees_chat_with": 1,
            "enable": true,
            "allow_users_save_chats": 0,
            "allow_panelists_send_direct_message": true,
            "default_attendees_chat_with": 1
        },
        "far_end_camera_control": true,
        "webinar_live_streaming": {
            "enable": true,
            "custom_service_instructions": "The specific instructions test",
            "live_streaming_service": [
                "facebook"
            ],
            "live_streaming_reminder": true
        },
        "meeting_polling": {
            "allow_alternative_host_to_add_edit": true,
            "enable": true,
            "require_answers_to_be_anonymous": true,
            "allow_host_to_upload_image": true,
            "manage_saved_polls_and_quizzes": true,
            "advanced_polls": true
        },
        "sending_default_email_invites": true,
        "who_can_share_screen_when_someone_is_sharing": "host",
        "e2e_encryption": true,
        "live_streaming_youtube": true,
        "webinar_reactions": true,
        "language_interpretation": {
            "allow_up_to_25_custom_languages_when_scheduling_meetings": true,
            "languages": "English",
            "custom_languages": [
                "English"
            ],
            "enable": true,
            "enable_language_interpretation_by_default": true,
            "allow_participants_to_speak_in_listening_channel": true
        },
        "meeting_reactions_emojis": "all",
        "disable_screen_sharing_for_host_meetings": true,
        "participants_share_simultaneously": "multiple",
        "unchecked_data_center_regions": "EU",
        "allow_users_to_delete_messages_in_meeting_chat": true,
        "closed_captioning": {
            "third_party_captioning_service": true,
            "enable": true,
            "save_caption": true,
            "view_full_transcript": true,
            "auto_transcribing": true
        },
        "alert_guest_join": true,
        "allow_host_panelists_to_use_audible_clap": true,
        "chat": true,
        "show_a_join_from_your_browser_link": true,
        "allow_live_streaming": true,
        "only_host_view_device_list": true,
        "show_meeting_control_toolbar": true,
        "stereo_audio": true,
        "breakout_room_schedule": true
    },
    "email_notification": {
        "recording_available_reminder_alternative_hosts": true,
        "cancel_meeting_reminder": true,
        "schedule_for_reminder": true,
        "alternative_host_reminder": true,
        "cloud_recording_available_reminder": true,
        "jbh_reminder": true,
        "recording_available_reminder_schedulers": true
    },
    "other_options": {
        "blur_snapshot": true,
        "webinar_registration_options": {
            "allow_host_to_enable_social_share_buttons": true,
            "enable_custom_questions": true,
            "allow_host_to_enable_join_info": true
        },
        "allow_users_contact_support_via_chat": true
    }
}
🟠404** HTTP状态代码: ** '404' <br> 未找到 ** 错误代码: ** '4130' <br> 组不存在: {groupId}。<br>

扫码加 ZOOM 开发者 微信交流

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

扫码加入交流群
上一页
更新群组的设置
下一页
创建组
Built with