zoom-automation

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Zoom Automation via Rube MCP

通过Rube MCP实现Zoom自动化

Automate Zoom operations including meeting scheduling, webinar management, cloud recording retrieval, participant tracking, and usage reporting through Composio's Zoom toolkit.
借助Composio的Zoom工具包,自动化Zoom操作,包括会议调度、网络研讨会管理、云录制检索、参会者追踪以及使用情况报告。

Prerequisites

前提条件

  • Rube MCP must be connected (RUBE_SEARCH_TOOLS available)
  • Active Zoom connection via
    RUBE_MANAGE_CONNECTIONS
    with toolkit
    zoom
  • Always call
    RUBE_SEARCH_TOOLS
    first to get current tool schemas
  • Most features require a paid Zoom account (Pro plan or higher)
  • 必须已连接Rube MCP(需确保
    RUBE_SEARCH_TOOLS
    可用)
  • 通过
    RUBE_MANAGE_CONNECTIONS
    并使用工具包
    zoom
    完成Zoom的激活连接
  • 请始终先调用
    RUBE_SEARCH_TOOLS
    以获取最新的工具架构
  • 大多数功能需要付费Zoom账户(Pro版或更高等级)

Setup

设置步骤

Get Rube MCP: Add
https://rube.app/mcp
as an MCP server in your client configuration. No API keys needed — just add the endpoint and it works.
  1. Verify Rube MCP is available by confirming
    RUBE_SEARCH_TOOLS
    responds
  2. Call
    RUBE_MANAGE_CONNECTIONS
    with toolkit
    zoom
  3. If connection is not ACTIVE, follow the returned auth link to complete Zoom OAuth
  4. Confirm connection status shows ACTIVE before running any workflows
获取Rube MCP:在客户端配置中添加
https://rube.app/mcp
作为MCP服务器。无需API密钥——只需添加端点即可使用。
  1. 确认
    RUBE_SEARCH_TOOLS
    能正常响应,以此验证Rube MCP是否可用
  2. 调用
    RUBE_MANAGE_CONNECTIONS
    并指定工具包
    zoom
  3. 如果连接状态未显示为ACTIVE,请按照返回的认证链接完成Zoom OAuth授权
  4. 在运行任何工作流之前,确认连接状态显示为ACTIVE

Core Workflows

核心工作流

1. Create and Schedule Meetings

1. 创建与调度会议

When to use: User wants to create a new Zoom meeting with specific time, duration, and settings
Tool sequence:
  1. ZOOM_GET_USER
    - Verify authenticated user and check license type [Prerequisite]
  2. ZOOM_CREATE_A_MEETING
    - Create the meeting with topic, time, duration, and settings [Required]
  3. ZOOM_GET_A_MEETING
    - Retrieve full meeting details including join_url [Optional]
  4. ZOOM_UPDATE_A_MEETING
    - Modify meeting settings or reschedule [Optional]
  5. ZOOM_ADD_A_MEETING_REGISTRANT
    - Register participants for registration-enabled meetings [Optional]
Key parameters:
  • userId
    : Always use
    "me"
    for user-level apps
  • topic
    : Meeting subject line
  • type
    :
    1
    (instant),
    2
    (scheduled),
    3
    (recurring no fixed time),
    8
    (recurring fixed time)
  • start_time
    : ISO 8601 format (
    yyyy-MM-ddTHH:mm:ssZ
    for UTC or
    yyyy-MM-ddTHH:mm:ss
    with timezone field)
  • timezone
    : Timezone ID (e.g.,
    "America/New_York"
    )
  • duration
    : Duration in minutes
  • settings__auto_recording
    :
    "none"
    ,
    "local"
    , or
    "cloud"
  • settings__waiting_room
    : Boolean to enable waiting room
  • settings__join_before_host
    : Boolean (disabled when waiting room is enabled)
  • settings__meeting_invitees
    : Array of invitee objects with email addresses
Pitfalls:
  • start_time
    must be in the future; Zoom stores and returns times in UTC regardless of input timezone
  • If no
    start_time
    is set for type
    2
    , it becomes an instant meeting that expires after 30 days
  • The
    join_url
    for participants and
    start_url
    for host come from the create response - persist these
  • start_url
    expires in 2 hours (or 90 days for
    custCreate
    users)
  • Meeting creation is rate-limited to 100 requests/day
  • Setting names use double underscores for nesting (e.g.,
    settings__host_video
    )
适用场景:用户需要创建具有特定时间、时长及设置的新Zoom会议
工具执行顺序:
  1. ZOOM_GET_USER
    - 验证已认证用户并检查许可证类型 [前提步骤]
  2. ZOOM_CREATE_A_MEETING
    - 创建包含主题、时间、时长及设置的会议 [必需步骤]
  3. ZOOM_GET_A_MEETING
    - 获取包含join_url在内的完整会议详情 [可选步骤]
  4. ZOOM_UPDATE_A_MEETING
    - 修改会议设置或重新调度 [可选步骤]
  5. ZOOM_ADD_A_MEETING_REGISTRANT
    - 为启用注册的会议添加参会者 [可选步骤]
关键参数:
  • userId
    : 用户级应用请始终使用
    "me"
  • topic
    : 会议主题
  • type
    :
    1
    (即时会议)、
    2
    (已调度会议)、
    3
    (无固定时间的 recurring 会议)、
    8
    (固定时间的 recurring 会议)
  • start_time
    : ISO 8601格式(UTC时间使用
    yyyy-MM-ddTHH:mm:ssZ
    ,带时区的时间使用
    yyyy-MM-ddTHH:mm:ss
    并配合timezone字段)
  • timezone
    : 时区ID(例如
    "America/New_York"
  • duration
    : 会议时长(分钟)
  • settings__auto_recording
    :
    "none"
    "local"
    "cloud"
  • settings__waiting_room
    : 布尔值,用于启用等候室
  • settings__join_before_host
    : 布尔值(启用等候室时该参数会自动禁用)
  • settings__meeting_invitees
    : 包含参会者邮箱的对象数组
注意事项:
  • start_time
    必须设置为未来时间;Zoom会将所有时间以UTC格式存储和返回,与输入时区无关
  • 如果类型为
    2
    的会议未设置
    start_time
    ,则会变为即时会议,30天后过期
  • 参会者的
    join_url
    和主持人的
    start_url
    会在创建会议的响应中返回,请妥善保存
  • start_url
    的有效期为2小时(
    custCreate
    用户的有效期为90天)
  • 会议创建接口的调用频率限制为每天100次
  • 嵌套设置项使用双下划线命名(例如
    settings__host_video

2. List and Manage Meetings

2. 会议列表与管理

When to use: User wants to view upcoming, live, or past meetings
Tool sequence:
  1. ZOOM_LIST_MEETINGS
    - List meetings by type (scheduled, live, upcoming, previous) [Required]
  2. ZOOM_GET_A_MEETING
    - Get detailed info for a specific meeting [Optional]
  3. ZOOM_UPDATE_A_MEETING
    - Modify meeting details [Optional]
Key parameters:
  • userId
    : Use
    "me"
    for authenticated user
  • type
    :
    "scheduled"
    (default),
    "live"
    ,
    "upcoming"
    ,
    "upcoming_meetings"
    ,
    "previous_meetings"
  • page_size
    : Records per page (default 30)
  • next_page_token
    : Pagination token from previous response
  • from
    /
    to
    : Date range filters
Pitfalls:
  • ZOOM_LIST_MEETINGS
    excludes instant meetings and only shows unexpired scheduled meetings
  • For past meetings, use
    type: "previous_meetings"
  • Pagination: always follow
    next_page_token
    until empty to get complete results
  • Token expiration:
    next_page_token
    expires after 15 minutes
  • Meeting IDs can exceed 10 digits; store as long integers, not standard integers
适用场景:用户需要查看即将召开、正在进行或已结束的会议
工具执行顺序:
  1. ZOOM_LIST_MEETINGS
    - 按类型列出会议(已调度、正在进行、即将召开、已结束) [必需步骤]
  2. ZOOM_GET_A_MEETING
    - 获取特定会议的详细信息 [可选步骤]
  3. ZOOM_UPDATE_A_MEETING
    - 修改会议详情 [可选步骤]
关键参数:
  • userId
    : 已认证用户请使用
    "me"
  • type
    :
    "scheduled"
    (默认)、
    "live"
    "upcoming"
    "upcoming_meetings"
    "previous_meetings"
  • page_size
    : 每页记录数(默认30条)
  • next_page_token
    : 上一次响应返回的分页令牌
  • from
    /
    to
    : 日期范围过滤器
注意事项:
  • ZOOM_LIST_MEETINGS
    不包含即时会议,仅显示未过期的已调度会议
  • 查看已结束的会议请使用
    type: "previous_meetings"
  • 分页处理:请始终跟随
    next_page_token
    直到其为空,以获取完整结果
  • 令牌过期:
    next_page_token
    的有效期为15分钟
  • 会议ID可能超过10位数字,请以长整数类型存储,而非标准整数

3. Manage Recordings

3. 录制内容管理

When to use: User wants to list, retrieve, or delete cloud recordings
Tool sequence:
  1. ZOOM_LIST_ALL_RECORDINGS
    - List all cloud recordings for a user within a date range [Required]
  2. ZOOM_GET_MEETING_RECORDINGS
    - Get recordings for a specific meeting [Optional]
  3. ZOOM_DELETE_MEETING_RECORDINGS
    - Move recordings to trash or permanently delete [Optional]
  4. ZOOM_LIST_ARCHIVED_FILES
    - List archived meeting/webinar files [Optional]
Key parameters:
  • userId
    : Use
    "me"
    for authenticated user
  • from
    /
    to
    : Date range in
    yyyy-mm-dd
    format (max 1 month range)
  • meetingId
    : Meeting ID or UUID for specific recording retrieval
  • action
    :
    "trash"
    (recoverable) or
    "delete"
    (permanent) for deletion
  • include_fields
    : Set to
    "download_access_token"
    to get JWT for downloading recordings
  • trash
    : Set
    true
    to list recordings from trash
Pitfalls:
  • Date range maximum is 1 month; API auto-adjusts
    from
    if range exceeds this
  • Cloud Recording must be enabled on the account
  • UUIDs starting with
    /
    or containing
    //
    must be double URL-encoded
  • ZOOM_DELETE_MEETING_RECORDINGS
    defaults to
    "trash"
    action (recoverable);
    "delete"
    is permanent
  • Download URLs require the OAuth token in the Authorization header for passcode-protected recordings
  • Requires Pro plan or higher
适用场景:用户需要列出、检索或删除云录制内容
工具执行顺序:
  1. ZOOM_LIST_ALL_RECORDINGS
    - 列出指定日期范围内用户的所有云录制内容 [必需步骤]
  2. ZOOM_GET_MEETING_RECORDINGS
    - 获取特定会议的录制内容 [可选步骤]
  3. ZOOM_DELETE_MEETING_RECORDINGS
    - 将录制内容移至回收站或永久删除 [可选步骤]
  4. ZOOM_LIST_ARCHIVED_FILES
    - 列出已归档的会议/网络研讨会文件 [可选步骤]
关键参数:
  • userId
    : 已认证用户请使用
    "me"
  • from
    /
    to
    : 日期范围,格式为
    yyyy-mm-dd
    (最大范围为1个月)
  • meetingId
    : 用于检索特定录制内容的会议ID或UUID
  • action
    : 删除操作类型,
    "trash"
    (可恢复)或
    "delete"
    (永久删除)
  • include_fields
    : 设置为
    "download_access_token"
    以获取用于下载录制内容的JWT令牌
  • trash
    : 设置为
    true
    以列出回收站中的录制内容
注意事项:
  • 日期范围最大为1个月;如果超出该范围,API会自动调整
    from
    参数
  • 账户必须启用云录制功能
  • /
    开头或包含
    //
    的UUID必须进行双重URL编码
  • ZOOM_DELETE_MEETING_RECORDINGS
    的默认操作是
    "trash"
    (可恢复);
    "delete"
    为永久删除
  • 受密码保护的录制内容的下载链接需要在Authorization请求头中携带OAuth令牌
  • 需要Pro版或更高等级的账户

4. Get Meeting Participants and Reports

4. 参会者与报告获取

When to use: User wants to see who attended a past meeting or get usage statistics
Tool sequence:
  1. ZOOM_GET_PAST_MEETING_PARTICIPANTS
    - List attendees of a completed meeting [Required]
  2. ZOOM_GET_A_MEETING
    - Get meeting details and registration info for upcoming meetings [Optional]
  3. ZOOM_GET_DAILY_USAGE_REPORT
    - Get daily usage statistics (meetings, participants, minutes) [Optional]
  4. ZOOM_GET_A_MEETING_SUMMARY
    - Get AI-generated meeting summary [Optional]
Key parameters:
  • meetingId
    : Meeting ID (latest instance) or UUID (specific occurrence)
  • page_size
    : Records per page (default 30)
  • next_page_token
    : Pagination token for large participant lists
Pitfalls:
  • ZOOM_GET_PAST_MEETING_PARTICIPANTS
    only works for completed meetings on paid plans
  • Solo meetings (no other participants) return empty results
  • UUID encoding: UUIDs starting with
    /
    or containing
    //
    must be double-encoded
  • Always paginate with
    next_page_token
    until empty to avoid dropping attendees
  • ZOOM_GET_A_MEETING_SUMMARY
    requires a paid plan with AI Companion enabled; free accounts get 400 errors
  • ZOOM_GET_DAILY_USAGE_REPORT
    has a Heavy rate limit; avoid frequent calls
适用场景:用户需要查看已结束会议的参会人员或获取使用统计数据
工具执行顺序:
  1. ZOOM_GET_PAST_MEETING_PARTICIPANTS
    - 列出已结束会议的参会者 [必需步骤]
  2. ZOOM_GET_A_MEETING
    - 获取即将召开会议的详情及注册信息 [可选步骤]
  3. ZOOM_GET_DAILY_USAGE_REPORT
    - 获取每日使用统计数据(会议数量、参会人数、时长) [可选步骤]
  4. ZOOM_GET_A_MEETING_SUMMARY
    - 获取AI生成的会议摘要 [可选步骤]
关键参数:
  • meetingId
    : 会议ID(最新实例)或UUID(特定场次)
  • page_size
    : 每页记录数(默认30条)
  • next_page_token
    : 用于处理大量参会者列表的分页令牌
注意事项:
  • ZOOM_GET_PAST_MEETING_PARTICIPANTS
    仅适用于付费账户的已结束会议
  • 无其他参会者的单人会议会返回空结果
  • UUID编码:以
    /
    开头或包含
    //
    的UUID必须进行双重编码
  • 请始终使用
    next_page_token
    进行分页处理,直到其为空,避免遗漏参会者
  • ZOOM_GET_A_MEETING_SUMMARY
    需要启用AI Companion功能的付费账户;免费账户调用会返回400错误
  • ZOOM_GET_DAILY_USAGE_REPORT
    的调用频率限制严格,请避免频繁调用

5. Manage Webinars

5. 网络研讨会管理

When to use: User wants to list webinars or register participants for webinars
Tool sequence:
  1. ZOOM_LIST_WEBINARS
    - List scheduled or upcoming webinars [Required]
  2. ZOOM_GET_A_WEBINAR
    - Get detailed webinar information [Optional]
  3. ZOOM_ADD_A_WEBINAR_REGISTRANT
    - Register a participant for a webinar [Optional]
Key parameters:
  • userId
    : Use
    "me"
    for authenticated user
  • type
    :
    "scheduled"
    (default) or
    "upcoming"
  • page_size
    : Records per page (default 30)
  • next_page_token
    : Pagination token
Pitfalls:
  • Webinar features require Pro plan or higher with Webinar add-on
  • Free/basic accounts cannot use webinar tools
  • Only shows unexpired webinars
  • Registration must be enabled on the webinar for
    ZOOM_ADD_A_WEBINAR_REGISTRANT
    to work
适用场景:用户需要列出网络研讨会或为参会者注册网络研讨会
工具执行顺序:
  1. ZOOM_LIST_WEBINARS
    - 列出已调度或即将召开的网络研讨会 [必需步骤]
  2. ZOOM_GET_A_WEBINAR
    - 获取网络研讨会的详细信息 [可选步骤]
  3. ZOOM_ADD_A_WEBINAR_REGISTRANT
    - 为参会者注册网络研讨会 [可选步骤]
关键参数:
  • userId
    : 已认证用户请使用
    "me"
  • type
    :
    "scheduled"
    (默认)或
    "upcoming"
  • page_size
    : 每页记录数(默认30条)
  • next_page_token
    : 分页令牌
注意事项:
  • 网络研讨会功能需要Pro版或更高等级账户,并添加网络研讨会附加组件
  • 免费/基础账户无法使用网络研讨会工具
  • 仅显示未过期的网络研讨会
  • 只有当网络研讨会启用注册功能时,
    ZOOM_ADD_A_WEBINAR_REGISTRANT
    才能正常工作

Common Patterns

通用模式

ID Resolution

ID解析

  • User ID: Always use
    "me"
    for user-level apps to refer to the authenticated user
  • Meeting ID: Numeric ID (store as long integer); use for latest instance
  • Meeting UUID: Use for specific occurrence of recurring meetings; double-encode if starts with
    /
    or contains
    //
  • Occurrence ID: Use with recurring meetings to target a specific occurrence
  • 用户ID: 用户级应用请始终使用
    "me"
    指代已认证用户
  • 会议ID: 数字ID(请以长整数类型存储);用于指向最新的会议实例
  • 会议UUID: 用于指向 recurring 会议的特定场次;如果UUID以
    /
    开头或包含
    //
    ,需要进行双重编码
  • 场次ID: 用于定位 recurring 会议的特定场次

Pagination

分页处理

Most Zoom list endpoints use token-based pagination:
  • Follow
    next_page_token
    until it is empty or missing
  • Token expires after 15 minutes
  • Set explicit
    page_size
    (default 30, varies by endpoint)
  • Do not use
    page_number
    (deprecated on many endpoints)
大多数Zoom列表类接口使用基于令牌的分页机制:
  • 请跟随
    next_page_token
    直到其为空或不存在
  • 令牌的有效期为15分钟
  • 显式设置
    page_size
    参数(默认30条,不同接口可能有所不同)
  • 请勿使用
    page_number
    参数(该参数在许多接口中已被弃用)

Time Handling

时间处理

  • Zoom stores all times in UTC internally
  • Provide
    timezone
    field alongside
    start_time
    for local time input
  • Use ISO 8601 format:
    yyyy-MM-ddTHH:mm:ssZ
    (UTC) or
    yyyy-MM-ddTHH:mm:ss
    (with timezone field)
  • Date-only fields use
    yyyy-mm-dd
    format
  • Zoom内部所有时间均以UTC格式存储
  • 输入本地时间时,请同时提供
    timezone
    字段
  • 使用ISO 8601格式:
    yyyy-MM-ddTHH:mm:ssZ
    (UTC时间)或
    yyyy-MM-ddTHH:mm:ss
    (配合timezone字段)
  • 仅日期的字段使用
    yyyy-mm-dd
    格式

Known Pitfalls

已知注意事项

Plan Requirements

账户版本要求

  • Most recording and participant features require Pro plan or higher
  • Webinar features require Webinar add-on
  • AI meeting summaries require AI Companion feature enabled
  • Archived files require "Meeting and Webinar Archiving" enabled by Zoom Support
  • 大多数录制和参会者相关功能需要Pro版或更高等级账户
  • 网络研讨会功能需要网络研讨会附加组件
  • AI会议摘要需要启用AI Companion功能
  • 归档文件功能需要Zoom支持团队启用“会议与网络研讨会归档”

Rate Limits

调用频率限制

  • Meeting creation: 100 requests/day, 100 updates per meeting in 24 hours
  • ZOOM_GET_PAST_MEETING_PARTICIPANTS
    : Moderate throttle; add delays for batch processing
  • ZOOM_GET_DAILY_USAGE_REPORT
    : Heavy rate limit
  • ZOOM_GET_A_MEETING
    ,
    ZOOM_GET_MEETING_RECORDINGS
    : Light rate limit
  • ZOOM_LIST_MEETINGS
    ,
    ZOOM_LIST_ALL_RECORDINGS
    : Medium rate limit
  • 会议创建:每天100次请求,每个会议24小时内最多可更新100次
  • ZOOM_GET_PAST_MEETING_PARTICIPANTS
    : 调用频率限制中等;批量处理时请添加延迟
  • ZOOM_GET_DAILY_USAGE_REPORT
    : 调用频率限制严格
  • ZOOM_GET_A_MEETING
    ZOOM_GET_MEETING_RECORDINGS
    : 调用频率限制宽松
  • ZOOM_LIST_MEETINGS
    ZOOM_LIST_ALL_RECORDINGS
    : 调用频率限制中等

Parameter Quirks

参数特殊规则

  • Nested settings use double underscore notation (e.g.,
    settings__waiting_room
    )
  • start_url
    expires in 2 hours; renew via API if needed
  • join_before_host
    is automatically disabled when
    waiting_room
    is
    true
  • Recurring meeting fields (
    recurrence__*
    ) only apply to type
    3
    and
    8
  • password
    field has max 10 characters with alphanumeric and
    @
    ,
    -
    ,
    _
    ,
    *
    only
  • 嵌套设置项使用双下划线命名(例如
    settings__waiting_room
  • start_url
    的有效期为2小时;如需延长可通过API重新获取
  • waiting_room
    设置为
    true
    时,
    join_before_host
    会自动禁用
  • Recurring会议字段(
    recurrence__*
    )仅适用于类型
    3
    8
    的会议
  • password
    字段最多包含10个字符,仅允许使用字母、数字及
    @
    -
    _
    *

Quick Reference

速查参考

TaskTool SlugKey Params
Create meeting
ZOOM_CREATE_A_MEETING
userId
,
topic
,
start_time
,
type
Get meeting details
ZOOM_GET_A_MEETING
meetingId
Update meeting
ZOOM_UPDATE_A_MEETING
meetingId
, fields to update
List meetings
ZOOM_LIST_MEETINGS
userId
,
type
,
page_size
Get user info
ZOOM_GET_USER
userId
List recordings
ZOOM_LIST_ALL_RECORDINGS
userId
,
from
,
to
Get recording
ZOOM_GET_MEETING_RECORDINGS
meetingId
Delete recording
ZOOM_DELETE_MEETING_RECORDINGS
meetingId
,
action
Past participants
ZOOM_GET_PAST_MEETING_PARTICIPANTS
meetingId
,
page_size
Daily usage report
ZOOM_GET_DAILY_USAGE_REPORT
date params
Meeting summary
ZOOM_GET_A_MEETING_SUMMARY
meetingId
List webinars
ZOOM_LIST_WEBINARS
userId
,
type
Get webinar
ZOOM_GET_A_WEBINAR
webinar ID
Register for meeting
ZOOM_ADD_A_MEETING_REGISTRANT
meetingId
, participant details
Register for webinar
ZOOM_ADD_A_WEBINAR_REGISTRANT
webinar ID, participant details
List archived files
ZOOM_LIST_ARCHIVED_FILES
from
,
to
任务工具标识关键参数
创建会议
ZOOM_CREATE_A_MEETING
userId
,
topic
,
start_time
,
type
获取会议详情
ZOOM_GET_A_MEETING
meetingId
更新会议
ZOOM_UPDATE_A_MEETING
meetingId
, 需要更新的字段
列出会议
ZOOM_LIST_MEETINGS
userId
,
type
,
page_size
获取用户信息
ZOOM_GET_USER
userId
列出录制内容
ZOOM_LIST_ALL_RECORDINGS
userId
,
from
,
to
获取录制内容
ZOOM_GET_MEETING_RECORDINGS
meetingId
删除录制内容
ZOOM_DELETE_MEETING_RECORDINGS
meetingId
,
action
已结束会议参会者
ZOOM_GET_PAST_MEETING_PARTICIPANTS
meetingId
,
page_size
每日使用报告
ZOOM_GET_DAILY_USAGE_REPORT
日期参数
会议摘要
ZOOM_GET_A_MEETING_SUMMARY
meetingId
列出网络研讨会
ZOOM_LIST_WEBINARS
userId
,
type
获取网络研讨会详情
ZOOM_GET_A_WEBINAR
网络研讨会ID
会议参会者注册
ZOOM_ADD_A_MEETING_REGISTRANT
meetingId
, 参会者详情
网络研讨会参会者注册
ZOOM_ADD_A_WEBINAR_REGISTRANT
网络研讨会ID, 参会者详情
列出归档文件
ZOOM_LIST_ARCHIVED_FILES
from
,
to