zoom-general
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseZoom General (Cross-Product Skills)
Zoom 通用(跨产品Skills)
Background reference for cross-product Zoom questions. Prefer the workflow skills first, then use this file for shared platform guidance and routing detail.
跨产品Zoom相关问题的背景参考。优先使用工作流skills,当需要共享平台指引和路由详情时再使用本文档。
How zoom-general
Routes a Complex Developer Query
zoom-generalzoom-general
如何路由复杂开发者查询
zoom-generalUse as the classifier and chaining layer:
zoom-general- detect product signals in the query
- pick one primary skill
- attach secondary skills for auth, events, or deployment edges
- ask one short clarifier only when two routes match with similar confidence
Minimal implementation:
ts
type SkillId =
| 'zoom-general'
| 'zoom-rest-api'
| 'zoom-webhooks'
| 'zoom-oauth'
| 'zoom-meeting-sdk-web-component-view'
| 'zoom-video-sdk'
| 'zoom-mcp';
const hasAny = (q: string, words: string[]) => words.some((w) => q.includes(w));
function detectSignals(rawQuery: string) {
const q = rawQuery.toLowerCase();
return {
meetingCustomUi: hasAny(q, ['zoom meeting', 'custom ui', 'component view', 'embed meeting']),
customVideo: hasAny(q, ['video sdk', 'custom video session', 'peer-video-state-change']),
restApi: hasAny(q, ['rest api', '/v2/', 'create meeting', 'list users', 's2s oauth']),
webhooks: hasAny(q, ['webhook', 'x-zm-signature', 'event subscription', 'crc']),
oauth: hasAny(q, ['oauth', 'pkce', 'token refresh', 'account_credentials']),
mcp: hasAny(q, ['zoom mcp', 'agentic retrieval', 'tools/list', 'semantic meeting search']),
};
}
function pickPrimarySkill(s: ReturnType<typeof detectSignals>): SkillId {
if (s.meetingCustomUi) return 'zoom-meeting-sdk-web-component-view';
if (s.mcp) return 'zoom-mcp';
if (s.restApi) return 'zoom-rest-api';
if (s.customVideo) return 'zoom-video-sdk';
return 'zoom-general';
}
function buildChain(primary: SkillId, s: ReturnType<typeof detectSignals>): SkillId[] {
const chain = [primary];
if (s.oauth && !chain.includes('zoom-oauth')) chain.push('zoom-oauth');
if (s.webhooks && !chain.includes('zoom-webhooks')) chain.push('zoom-webhooks');
return chain;
}Example:
- ->
Create a meeting, configure webhooks, and handle OAuth token refreshzoom-rest-api -> zoom-oauth -> zoom-webhooks - ->
Build a custom video UI for a Zoom meeting on webzoom-meeting-sdk-web-component-view
For the full TypeScript implementation and handoff contract, use
references/routing-implementation.md.
将用作分类器和链路层:
zoom-general- 检测查询中的产品信号
- 选择一个主skill
- 附加身份验证、事件或部署边缘场景的次级skills
- 仅当两条路由匹配置信度相近时,询问一个简短的澄清问题
最简实现:
ts
type SkillId =
| 'zoom-general'
| 'zoom-rest-api'
| 'zoom-webhooks'
| 'zoom-oauth'
| 'zoom-meeting-sdk-web-component-view'
| 'zoom-video-sdk'
| 'zoom-mcp';
const hasAny = (q: string, words: string[]) => words.some((w) => q.includes(w));
function detectSignals(rawQuery: string) {
const q = rawQuery.toLowerCase();
return {
meetingCustomUi: hasAny(q, ['zoom meeting', 'custom ui', 'component view', 'embed meeting']),
customVideo: hasAny(q, ['video sdk', 'custom video session', 'peer-video-state-change']),
restApi: hasAny(q, ['rest api', '/v2/', 'create meeting', 'list users', 's2s oauth']),
webhooks: hasAny(q, ['webhook', 'x-zm-signature', 'event subscription', 'crc']),
oauth: hasAny(q, ['oauth', 'pkce', 'token refresh', 'account_credentials']),
mcp: hasAny(q, ['zoom mcp', 'agentic retrieval', 'tools/list', 'semantic meeting search']),
};
}
function pickPrimarySkill(s: ReturnType<typeof detectSignals>): SkillId {
if (s.meetingCustomUi) return 'zoom-meeting-sdk-web-component-view';
if (s.mcp) return 'zoom-mcp';
if (s.restApi) return 'zoom-rest-api';
if (s.customVideo) return 'zoom-video-sdk';
return 'zoom-general';
}
function buildChain(primary: SkillId, s: ReturnType<typeof detectSignals>): SkillId[] {
const chain = [primary];
if (s.oauth && !chain.includes('zoom-oauth')) chain.push('zoom-oauth');
if (s.webhooks && !chain.includes('zoom-webhooks')) chain.push('zoom-webhooks');
return chain;
}示例:
- ->
创建会议、配置webhooks、处理OAuth令牌刷新zoom-rest-api -> zoom-oauth -> zoom-webhooks - ->
为Web端Zoom会议构建自定义视频UIzoom-meeting-sdk-web-component-view
完整TypeScript实现和交接合约请参考
references/routing-implementation.md。
Choose Your Path
选择你的开发路径
| I want to... | Use this skill |
|---|---|
| Build a custom web UI around a real Zoom meeting | zoom-meeting-sdk-web-component-view |
| Build deterministic automation/configuration/reporting with explicit request control | zoom-rest-api |
| Receive event notifications (HTTP push) | zoom-webhooks |
| Receive event notifications (WebSocket, low-latency) | zoom-websockets |
| Embed Zoom meetings in my app | zoom-meeting-sdk |
| Build custom video experiences (Web, React Native, Flutter, Android, iOS, macOS, Unity, Linux) | zoom-video-sdk |
| Build an app that runs inside Zoom client | zoom-apps-sdk |
| Transcribe uploaded or stored media with AI Services Scribe | scribe |
| Access live audio/video/transcripts from meetings | zoom-rtms |
| Enable collaborative browsing for support | zoom-cobrowse-sdk |
| Build Contact Center apps and channel integrations | contact-center |
| Build Virtual Agent web/mobile chatbot experiences | virtual-agent |
| Build Zoom Phone integrations (Smart Embed, Phone API, webhooks, URI flows) | phone |
| Build Team Chat apps and integrations | zoom-team-chat |
| Build server-side integrations with Rivet (auth + webhooks + APIs) | rivet-sdk |
| Run browser/device/network preflight diagnostics before join | probe-sdk |
| Add pre-built UI components for Video SDK | zoom-ui-toolkit |
| Implement OAuth authentication (all grant types) | zoom-oauth |
| Build AI-driven tool workflows (AI Companion/agents) over Zoom data | zoom-mcp |
| Build AI-driven Whiteboard workflows over Zoom Whiteboard MCP | zoom-mcp/whiteboard |
| Build enterprise AI systems with stable API core + AI tool layer | zoom-rest-api + zoom-mcp |
| 我想要... | 使用该skill |
|---|---|
| 为实时Zoom会议构建自定义Web UI | zoom-meeting-sdk-web-component-view |
| 通过显式请求控制构建确定性自动化/配置/报表功能 | zoom-rest-api |
| 接收事件通知(HTTP推送) | zoom-webhooks |
| 接收事件通知(WebSocket,低延迟) | zoom-websockets |
| 在我的应用中嵌入Zoom会议 | zoom-meeting-sdk |
| 构建自定义视频体验(Web、React Native、Flutter、Android、iOS、macOS、Unity、Linux) | zoom-video-sdk |
| 构建运行在Zoom客户端内的应用 | zoom-apps-sdk |
| 使用AI Services Scribe为上传或存储的媒体生成转录文本 | scribe |
| 访问会议的实时音视频/转录文本 | zoom-rtms |
| 为客服场景启用协同浏览 | zoom-cobrowse-sdk |
| 构建联络中心应用和渠道集成 | contact-center |
| 构建Virtual Agent Web/移动端聊天机器人体验 | virtual-agent |
| 构建Zoom Phone集成(智能嵌入、Phone API、webhooks、URI流程) | phone |
| 构建Team Chat应用和集成 | zoom-team-chat |
| 使用Rivet构建服务端集成(身份验证 + webhooks + API) | rivet-sdk |
| 在加入会议前运行浏览器/设备/网络预检诊断 | probe-sdk |
| 为Video SDK添加预制UI组件 | zoom-ui-toolkit |
| 实现OAuth身份验证(所有授权类型) | zoom-oauth |
| 基于Zoom数据构建AI驱动的工具工作流(AI Companion/agents) | zoom-mcp |
| 基于Zoom白板MCP构建AI驱动的白板工作流 | zoom-mcp/whiteboard |
| 构建具备稳定API核心 + AI工具层的企业级AI系统 | zoom-rest-api + zoom-mcp |
Planning Checkpoint: Rivet SDK (Optional)
规划检查点:Rivet SDK(可选)
When a user starts planning a server-side integration that combines auth + webhooks + API calls, ask this first:
Rivet SDK is a Node.js framework that bundles Zoom auth handling, webhook receivers, and typed API wrappers.Do you want to use Rivet SDK for faster scaffolding, or do you prefer a direct OAuth + REST implementation without Rivet?
Routing after answer:
- If user chooses Rivet: chain +
rivet-sdk+oauth.rest-api - If user declines Rivet: chain +
oauth(+rest-apior product skill as needed).webhooks
当用户开始规划结合了身份验证 + webhooks + API调用的服务端集成时,首先询问:
Rivet SDK是一个Node.js框架,封装了Zoom身份验证处理、webhook接收器和类型化API封装。你是否想要使用Rivet SDK来快速搭建脚手架,还是偏好不使用Rivet的原生OAuth + REST实现?
根据回答路由:
- 如果用户选择Rivet:链路为 +
rivet-sdk+oauthrest-api - 如果用户不选择Rivet:链路为 +
oauth(按需添加rest-api或产品skill)webhooks
SDK vs REST Routing Matrix (Hard Stop)
SDK与REST路由矩阵(硬性规则)
| User intent | Correct path | Do not route to |
|---|---|---|
| Embed Zoom meeting in app UI | | REST-only |
| Build custom web UI for a real Zoom meeting | | |
| Build custom video UI/session app | | Meeting SDK or REST meeting links |
| Get browser join links / manage meeting resources | | Meeting SDK join implementation |
Routing guardrails:
- If user asks for SDK embed/join behavior, stay in SDK path.
- If the prompt says meeting plus custom UI/video/layout/embed, prefer .
zoom-meeting-sdk-web-component-view - Only use when the user is building a custom session product rather than a Zoom meeting.
zoom-video-sdk - Only use REST path for resource management, reporting, or link distribution unless user explicitly requests a mixed architecture.
- For executable classification/chaining logic and error handling, see references/routing-implementation.md.
| 用户意图 | 正确路径 | 不要路由到 |
|---|---|---|
| 在应用UI中嵌入Zoom会议 | | 仅使用REST的 |
| 为实时Zoom会议构建自定义Web UI | | |
| 构建自定义视频UI/会话应用 | | Meeting SDK或REST会议链接 |
| 获取浏览器加入链接/管理会议资源 | | Meeting SDK加入实现 |
路由规则:
- 如果用户询问SDK嵌入/加入行为,保持在SDK路径
- 如果提示同时包含会议和自定义UI/视频/布局/嵌入,优先选择
zoom-meeting-sdk-web-component-view - 仅当用户构建自定义会话产品而非Zoom会议时,才使用
zoom-video-sdk - 仅当用户明确要求混合架构时,才对资源管理、报表或链接分发场景使用非REST路径
- 可执行分类/链路逻辑和错误处理请参考 references/routing-implementation.md
API vs MCP Routing Matrix (Hard Stop)
API与MCP路由矩阵(硬性规则)
| User intent | Correct path | Why |
|---|---|---|
| Deterministic backend automation, account/user configuration, reporting, scheduled jobs | | Explicit request/response control and repeatable behavior |
| AI agent chooses tools dynamically, cross-platform AI tool interoperability | | MCP is optimized for dynamic tool discovery and agentic workflows |
| Enterprise AI architecture (stable core + adaptive AI layer) | | APIs run core system actions; MCP exposes curated AI tools/context |
Routing guardrails:
- Do not replace deterministic backend APIs with MCP-only routing.
- Do not force raw REST-first routing when the task is AI-agent tool orchestration.
- Prefer hybrid routing when the user needs both stable automation and AI-driven interactions.
- MCP remote server works over Streamable HTTP/SSE; use this path when the target client/agent supports MCP transports (for example Claude or VS Code).
- Do not design per-tenant custom MCP endpoint provisioning; Zoom MCP endpoints are shared at instance/cluster level.
- Source: https://developers.zoom.us/docs/mcp/library/resources/apis-vs-mcp/
| 用户意图 | 正确路径 | 原因 |
|---|---|---|
| 确定性后端自动化、账户/用户配置、报表、定时任务 | | 显式请求/响应控制和可重复行为 |
| AI agent动态选择工具、跨平台AI工具互操作性 | | MCP针对动态工具发现和代理工作流做了优化 |
| 企业级AI架构(稳定核心 + 自适应AI层) | | API运行核心系统操作;MCP暴露精选AI工具/上下文 |
路由规则:
- 不要用仅MCP的路由替换确定性后端API
- 当任务是AI-agent工具编排时,不要强制使用原生REST优先的路由
- 当用户同时需要稳定自动化和AI驱动交互时,优先选择混合路由
- MCP远程服务基于可流式HTTP/SSE运行;当目标客户端/agent支持MCP传输协议时使用该路径(例如Claude或VS Code)
- 不要设计按租户定制的MCP端点配置;Zoom MCP端点在实例/集群级别共享
- 来源:https://developers.zoom.us/docs/mcp/library/resources/apis-vs-mcp/
Ambiguity Resolution (Ask Before Routing)
歧义解决(路由前询问)
When a prompt matches both API and MCP paths with similar confidence, ask one short clarifier before execution:
Do you want deterministic REST API automation, AI-agent MCP tooling, or a hybrid of both?
Then route as:
- REST answer →
zoom-rest-api - MCP answer →
zoom-mcp - Hybrid answer →
zoom-rest-api + zoom-mcp
当一个提示同时匹配API和MCP路径且置信度相近时,执行前先询问一个简短的澄清问题:
你想要确定性REST API自动化、AI-agent MCP工具,还是两者的混合方案?
然后按如下规则路由:
- REST需求 →
zoom-rest-api - MCP需求 →
zoom-mcp - 混合需求 →
zoom-rest-api + zoom-mcp
MCP Availability and Topology Notes
MCP可用性与拓扑说明
- Zoom-hosted MCP access is evolving; docs indicate a model where Zoom exposes product-scoped MCP servers (for example Meetings, Team Chat, Whiteboard).
- Use as the parent MCP entry point.
zoom-mcp - Route Whiteboard-specific MCP requests to zoom-mcp/whiteboard.
- When a request is product-specific and MCP coverage exists, route to that MCP product surface first; otherwise use REST/SDK skills for deterministic implementation.
- Zoom托管的MCP访问能力正在迭代中;文档表明Zoom将开放产品维度的MCP服务器(例如会议、Team Chat、白板)
- 使用作为MCP的总入口
zoom-mcp - 将白板专属的MCP请求路由到 zoom-mcp/whiteboard
- 当请求是产品专属且有MCP覆盖时,优先路由到对应的MCP产品层;否则使用REST/SDK skills实现确定性功能
Webhooks vs WebSockets
Webhooks与WebSockets对比
Both receive event notifications, but differ in approach:
| Aspect | webhooks | zoom-websockets |
|---|---|---|
| Connection | HTTP POST to your endpoint | Persistent WebSocket |
| Latency | Higher | Lower |
| Security | Requires public endpoint | No exposed endpoint |
| Setup | Simpler | More complex |
| Best for | Most use cases | Real-time, security-sensitive |
两者都用于接收事件通知,但实现方式不同:
| 维度 | webhooks | zoom-websockets |
|---|---|---|
| 连接方式 | 向你的端点发送HTTP POST | 持久化WebSocket连接 |
| 延迟 | 较高 | 较低 |
| 安全性 | 需要公网可访问的端点 | 无需暴露端点 |
| 配置难度 | 更简单 | 更复杂 |
| 适用场景 | 大多数场景 | 实时、对安全敏感的场景 |
Common Use Cases
常见用例
| Use Case | Description | Skills Needed |
|---|---|---|
| Meeting + Webhooks + OAuth Refresh | Create a meeting, process real-time updates, and refresh OAuth tokens safely in one design | zoom-rest-api + zoom-oauth + zoom-webhooks |
| Scribe Transcription Pipeline | Transcribe uploaded files or S3 archives with AI Services Scribe using fast mode or batch jobs | scribe + optional zoom-rest-api + optional zoom-webhooks |
| APIs vs MCP Routing | Decide whether to route to deterministic Zoom APIs, AI-driven MCP, or a hybrid design | zoom-rest-api and/or zoom-mcp |
| Custom Meeting UI (Web) | Build a custom video UI for a real Zoom meeting in a web app using Meeting SDK Component View | zoom-meeting-sdk-web-component-view + zoom-oauth |
| Meeting Automation | Schedule, update, delete meetings programmatically | zoom-rest-api |
| Meeting Bots | Build bots that join meetings for AI/transcription/recording | meeting-sdk/linux + zoom-rest-api + optional zoom-webhooks |
| High-Volume Meeting Platform | Design distributed meeting creation and event processing with retries, queues, and reconciliation | zoom-rest-api + zoom-webhooks + zoom-oauth |
| Recording & Transcription | Download recordings, get transcripts | zoom-webhooks + zoom-rest-api |
| Recording Download Pipeline | Auto-download recordings to your own storage (S3, GCS, etc.) | zoom-webhooks + zoom-rest-api |
| Real-Time Media Streams | Access live audio, video, transcripts via WebSocket | zoom-rtms + zoom-webhooks |
| In-Meeting Apps | Build apps that run inside Zoom meetings | zoom-apps-sdk + zoom-oauth |
| React Native Meeting Embed | Embed meetings into iOS/Android React Native apps | zoom-meeting-sdk-react-native + zoom-oauth |
| Native Meeting SDK Multi-Platform Delivery | Align Android, iOS, macOS, and Unreal Meeting SDK implementations under one auth/version strategy | zoom-meeting-sdk + platform skills |
| Native Video SDK Multi-Platform Delivery | Align Android, iOS, macOS, and Unity Video SDK implementations under one auth/version strategy | zoom-video-sdk + platform skills |
| Electron Meeting Embed | Embed meetings into desktop Electron apps | zoom-meeting-sdk-electron + zoom-oauth |
| Flutter Video Sessions | Build custom mobile video sessions in Flutter | zoom-video-sdk-flutter + zoom-oauth |
| React Native Video Sessions | Build custom mobile video sessions in React Native | zoom-video-sdk-react-native + zoom-oauth |
| Immersive Experiences | Custom video layouts with Layers API | zoom-apps-sdk |
| Collaborative Apps | Real-time shared state in meetings | zoom-apps-sdk |
| Contact Center App Lifecycle and Context Switching | Build Contact Center apps that handle engagement events and multi-engagement state | contact-center + zoom-apps-sdk |
| Virtual Agent Campaign Web and Mobile Wrapper | Deliver one campaign-driven bot flow across web and native mobile wrappers | virtual-agent + contact-center |
| Virtual Agent Knowledge Base Sync Pipeline | Sync external knowledge content into Zoom Virtual Agent using web sync or custom API connectors | virtual-agent + zoom-rest-api + zoom-oauth |
| Zoom Phone Smart Embed CRM Integration | Build CRM dialer and call logging flows using Smart Embed plus Phone APIs | phone + zoom-oauth + zoom-webhooks |
| Rivet Event-Driven API Orchestrator | Build a Node.js backend that combines webhooks and API actions through Rivet module clients | rivet-sdk + zoom-oauth + zoom-rest-api |
| Probe SDK Preflight Readiness Gate | Add browser/device/network diagnostics and readiness policy before Meeting SDK or Video SDK joins | probe-sdk + zoom-meeting-sdk or zoom-video-sdk |
| 用例 | 描述 | 需要的Skills |
|---|---|---|
| 会议 + Webhooks + OAuth刷新 | 在一个设计中完成创建会议、处理实时更新、安全刷新OAuth令牌的功能 | zoom-rest-api + zoom-oauth + zoom-webhooks |
| Scribe转录流水线 | 使用AI Services Scribe的快速模式或批量任务为上传文件或S3归档文件生成转录文本 | scribe + 可选 zoom-rest-api + 可选 zoom-webhooks |
| API与MCP路由选择 | 决定是路由到确定性Zoom API、AI驱动的MCP,还是混合设计 | zoom-rest-api 和/或 zoom-mcp |
| 自定义会议UI(Web端) | 使用Meeting SDK组件视图为Web应用中的实时Zoom会议构建自定义视频UI | zoom-meeting-sdk-web-component-view + zoom-oauth |
| 会议自动化 | 可编程地调度、更新、删除会议 | zoom-rest-api |
| 会议机器人 | 构建可加入会议完成AI/转录/录制功能的机器人 | meeting-sdk/linux + zoom-rest-api + 可选 zoom-webhooks |
| 高并发会议平台 | 设计带重试、队列、对账降级机制的分布式会议创建和事件处理流程 | zoom-rest-api + zoom-webhooks + zoom-oauth |
| 录制与转录 | 下载录制文件、获取转录文本 | zoom-webhooks + zoom-rest-api |
| 录制文件下载流水线 | 自动下载录制文件到你自己的存储(S3、GCS等) | zoom-webhooks + zoom-rest-api |
| 实时媒体流 | 通过WebSocket访问实时音视频、转录文本 | zoom-rtms + zoom-webhooks |
| 会议内应用 | 构建运行在Zoom会议内的应用 | zoom-apps-sdk + zoom-oauth |
| React Native会议嵌入 | 将会议嵌入到iOS/Android React Native应用中 | zoom-meeting-sdk-react-native + zoom-oauth |
| 原生Meeting SDK多平台交付 | 在同一身份验证/版本策略下对齐Android、iOS、macOS和Unreal Meeting SDK的实现 | zoom-meeting-sdk + 平台skills |
| 原生Video SDK多平台交付 | 在同一身份验证/版本策略下对齐Android、iOS、macOS和Unity Video SDK的实现 | zoom-video-sdk + 平台skills |
| Electron会议嵌入 | 将会议嵌入到桌面Electron应用中 | zoom-meeting-sdk-electron + zoom-oauth |
| Flutter视频会话 | 在Flutter中构建自定义移动端视频会话 | zoom-video-sdk-flutter + zoom-oauth |
| React Native视频会话 | 在React Native中构建自定义移动端视频会话 | zoom-video-sdk-react-native + zoom-oauth |
| 沉浸式体验 | 使用Layers API实现自定义视频布局 | zoom-apps-sdk |
| 协同应用 | 会议内实时共享状态 | zoom-apps-sdk |
| 联络中心应用生命周期与上下文切换 | 构建可处理 engagement 事件和多 engagement 状态的联络中心应用 | contact-center + zoom-apps-sdk |
| Virtual Agent活动Web与移动端封装 | 在Web和原生移动端封装中交付同一活动驱动的机器人流程 | virtual-agent + contact-center |
| Virtual Agent知识库同步流水线 | 使用网页同步或自定义API连接器将外部知识内容同步到Zoom Virtual Agent | virtual-agent + zoom-rest-api + zoom-oauth |
| Zoom Phone智能嵌入CRM集成 | 使用智能嵌入和Phone API构建CRM拨号器和通话记录流程 | phone + zoom-oauth + zoom-webhooks |
| Rivet事件驱动API编排器 | 构建通过Rivet模块客户端结合webhooks和API操作的Node.js后端 | rivet-sdk + zoom-oauth + zoom-rest-api |
| Probe SDK预检就绪检查 | 在Meeting SDK或Video SDK加入前添加浏览器/设备/网络诊断和就绪策略 | probe-sdk + zoom-meeting-sdk 或 zoom-video-sdk |
Complete Use-Case Index
完整用例索引
- APIs vs MCP Routing: choose API-only, MCP-only, or hybrid routing using official Zoom criteria.
- AI Companion Integration: connect Zoom AI Companion capabilities into your app workflow.
- AI Integration: add summarization, transcription, or assistant logic using Zoom data surfaces.
- Backend Automation (S2S OAuth): run server-side jobs with account-level OAuth credentials.
- Collaborative Apps: build shared in-meeting app state and interactions.
- Contact Center Integration: connect Zoom Contact Center signals into external systems.
- Contact Center App Lifecycle and Context Switching: implement event-driven engagement state and safe context switching in Contact Center apps.
- Virtual Agent Campaign Web and Mobile Wrapper: deploy campaign-based Virtual Agent chat across website and Android/iOS WebView wrappers.
- Virtual Agent Knowledge Base Sync Pipeline: automate knowledge-base ingestion with web sync strategy or custom API connector.
- Zoom Phone Smart Embed CRM Integration: integrate Smart Embed events, Phone APIs, and CRM workflows with migration-safe data handling.
- Rivet Event-Driven API Orchestrator: build a Node.js backend that combines webhook handling and API orchestration with Rivet.
- Probe SDK Preflight Readiness Gate: run browser/device/network diagnostics before launching meeting or video session workflows.
- Custom Video: decide between Video SDK and related components for custom session UX.
- Custom Meeting UI (Web): use Meeting SDK Component View for a custom UI around a real Zoom meeting.
- Scribe Transcription Pipeline: use AI Services Scribe for on-demand file transcription and batch archive processing.
- Video SDK Bring Your Own Storage: configure Video SDK cloud recordings to write directly to your own S3 bucket.
- Customer Support Cobrowsing: implement customer-agent collaborative browsing support flows.
- Embed Meetings: embed Zoom meeting experience into your app.
- Form Completion Assistant: build guided flows for form filling and completion assistance.
- HD Video Resolution: enable and troubleshoot high-definition video requirements.
- High-Volume Meeting Platform: build distributed meeting creation and event processing with concrete fallback patterns.
- Immersive Experiences: use Zoom Apps Layers APIs for custom in-meeting visuals.
- In-Meeting Apps: build Zoom Apps that run directly inside meeting and webinar contexts.
- Marketplace Publishing: prepare and ship a Zoom app through Marketplace review.
- Meeting Automation: create, update, and manage meetings programmatically.
- Meeting Bots: build bots for meeting join, capture, and real-time analysis.
- Native Meeting SDK Multi-Platform Delivery: standardize Android, iOS, macOS, and Unreal Meeting SDK delivery with shared auth and version controls.
- Native Video SDK Multi-Platform Delivery: standardize Android, iOS, macOS, and Unity Video SDK delivery with shared auth and version controls.
- Meeting Details with Events: combine REST retrieval with webhook event streams.
- Minutes Calculation: compute usage and minute metrics across meetings/sessions.
- Prebuilt Video UI: use UI Toolkit for faster Video SDK-based UI delivery.
- QSS Monitoring: monitor Zoom quality statistics and performance indicators.
- Raw Recording: capture raw streams for custom recording and processing pipelines.
- Electron Meeting Embed: embed meetings in an Electron desktop application.
- Flutter Video Sessions: build Video SDK sessions in Flutter mobile apps.
- React Native Meeting Embed: embed Meeting SDK into React Native apps.
- React Native Video Sessions: build custom video sessions in React Native.
- Real-Time Media Streams: consume live media/transcript streams via RTMS.
- Recording Download Pipeline: automate recording retrieval and storage pipelines.
- Recording & Transcription: manage post-meeting recordings and transcript workflows.
- Retrieve Meeting and Subscribe Events: join REST meeting fetch with event subscriptions.
- SaaS App OAuth Integration: implement user-level OAuth in multi-tenant SaaS apps.
- SDK Size Optimization: reduce bundle/runtime footprint for SDK-based apps.
- SDK Wrappers and GUI: evaluate wrapper patterns and GUI frameworks around SDKs.
- Team Chat LLM Bot: build a Team Chat bot with LLM-powered responses.
- Testing and Development: local testing patterns, mocks, and safe development loops.
- Token and Scope Troubleshooting: debug OAuth scope and token mismatch issues.
- Transcription Bot (Linux): run Linux meeting bots for live transcription workloads.
- Usage Reporting and Analytics: collect and analyze usage/reporting data.
- User and Meeting Creation: provision users and schedule meetings in one flow.
- Web SDK Embedding: embed meeting experiences in browser-based web apps.
- Server-to-Server OAuth with Webhooks: combine account OAuth with event-driven backend processing.
- Meeting Links vs Embedding: choose between distribution and SDK embedding.
join_url - Enterprise App Deployment: deploy, govern, and operate Zoom integrations at enterprise scale.
- API与MCP路由选择:使用Zoom官方标准选择仅API、仅MCP或混合路由
- AI Companion集成:将Zoom AI Companion能力接入你的应用工作流
- AI集成:基于Zoom数据面添加摘要、转录或助理逻辑
- 后端自动化(S2S OAuth):使用账户级OAuth凭证运行服务端任务
- 协同应用:构建会议内共享应用状态和交互功能
- 联络中心集成:将Zoom联络中心信号接入外部系统
- 联络中心应用生命周期与上下文切换:在联络中心应用中实现事件驱动的engagement状态和安全上下文切换
- Virtual Agent活动Web与移动端封装:在网站和Android/iOS WebView封装中部署基于活动的Virtual Agent聊天功能
- Virtual Agent知识库同步流水线:使用网页同步策略或自定义API连接器实现知识库摄入自动化
- Zoom Phone智能嵌入CRM集成:集成智能嵌入事件、Phone API和CRM工作流,实现迁移安全的数据处理
- Rivet事件驱动API编排器:使用Rivet构建结合webhook处理和API编排的Node.js后端
- Probe SDK预检就绪检查:在启动会议或视频会话工作流前运行浏览器/设备/网络诊断
- 自定义视频:为自定义会话UX选择Video SDK和相关组件
- 自定义会议UI(Web端):使用Meeting SDK组件视图为实时Zoom会议构建自定义UI
- Scribe转录流水线:使用AI Services Scribe实现按需文件转录和批量归档处理
- Video SDK自带存储:配置Video SDK云录制直接写入你自己的S3存储桶
- 客户支持协同浏览:实现客户-客服协同浏览支持流程
- 嵌入会议:将Zoom会议体验嵌入到你的应用中
- 表单填写助理:构建表单填写和完成辅助的引导流程
- HD视频分辨率:启用和排查高清视频需求
- 高并发会议平台:构建具备具体降级模式的分布式会议创建和事件处理流程
- 沉浸式体验:使用Zoom Apps Layers API实现自定义会议内视觉效果
- 会议内应用:构建直接运行在会议和网络研讨会场景中的Zoom Apps
- 应用市场发布:准备并通过应用市场审核发布Zoom应用
- 会议自动化:可编程地创建、更新和管理会议
- 会议机器人:构建用于会议加入、采集和实时分析的机器人
- 原生Meeting SDK多平台交付:通过共享身份验证和版本控制标准化Android、iOS、macOS和Unreal Meeting SDK的交付
- 原生Video SDK多平台交付:通过共享身份验证和版本控制标准化Android、iOS、macOS和Unity Video SDK的交付
- 带事件的会议详情:结合REST检索和webhook事件流
- 分钟数计算:计算会议/会话的使用量和分钟指标
- 预制视频UI:使用UI Toolkit快速交付基于Video SDK的UI
- QSS监控:监控Zoom质量统计数据和性能指标
- 原始录制:采集原始流用于自定义录制和处理流水线
- Electron会议嵌入:将会议嵌入到Electron桌面应用中
- Flutter视频会话:在Flutter移动端应用中构建Video SDK会话
- React Native会议嵌入:将Meeting SDK嵌入到React Native应用中
- React Native视频会话:在React Native中构建自定义视频会话
- 实时媒体流:通过RTMS消费实时媒体/转录流
- 录制文件下载流水线:实现录制文件检索和存储流水线自动化
- 录制与转录:管理会后录制和转录工作流
- 获取会议和订阅事件:结合REST会议拉取和事件订阅
- SaaS应用OAuth集成:在多租户SaaS应用中实现用户级OAuth
- SDK体积优化:减少基于SDK的应用的包/运行时占用
- SDK封装和GUI:评估SDK的封装模式和GUI框架
- Team Chat LLM机器人:构建具备LLM驱动响应能力的Team Chat机器人
- 测试与开发:本地测试模式、Mock和安全开发循环
- 令牌和Scope排查:调试OAuth scope和令牌不匹配问题
- 转录机器人(Linux):运行Linux会议机器人处理实时转录工作负载
- 使用量报表和分析:采集和分析使用量/报表数据
- 用户和会议创建:在一个流程中完成用户开通和会议调度
- Web SDK嵌入:将会议体验嵌入到浏览器端Web应用中
- 服务端到服务端OAuth + Webhooks:结合账户OAuth和事件驱动的后端处理
- 会议链接 vs 嵌入:选择分发和SDK嵌入方案
join_url - 企业级应用部署:在企业级规模部署、治理和运营Zoom集成
Prerequisites
前置条件
- Zoom account (Pro, Business, or Enterprise)
- App created in Zoom App Marketplace
- OAuth credentials (Client ID and Secret)
- Zoom账户(专业版、商业版或企业版)
- 在Zoom App Marketplace中创建的应用
- OAuth凭证(Client ID和Secret)
References
参考资料
- Known Limitations & Quirks
- 已知限制与注意事项
Quick Start
快速开始
- Go to marketplace.zoom.us
- Click Develop → Build App
- Select app type (see references/app-types.md)
- Configure OAuth and scopes
- Copy credentials to your application
- 访问 marketplace.zoom.us
- 点击 Develop → Build App
- 选择应用类型(参考references/app-types.md)
- 配置OAuth和scopes
- 将凭证复制到你的应用中
Detailed References
详细参考
- references/authentication.md - OAuth 2.0, S2S OAuth, JWT patterns
- references/app-types.md - Decision guide for app types
- references/scopes.md - OAuth scopes reference
- references/marketplace.md - Marketplace portal navigation
- references/query-routing-playbook.md - Route complex queries to the right specialized skills
- references/interview-answer-routing.md - Short interview-ready answer pattern for zoom-general routing
- references/routing-implementation.md - Concrete TypeScript query classification and skill handoff contract
- references/automatic-skill-chaining-rest-webhooks.md - Executable process for REST + webhook chained workflows
- references/meeting-webhooks-oauth-refresh-orchestration.md - Concrete design for meeting creation + webhook updates + OAuth token refresh
- references/distributed-meeting-fallback-architecture.md - High-volume distributed architecture with retries, circuit breakers, and reconciliation fallbacks
- references/community-repos.md - Curated official Zoom sample repositories by product
- references/authentication.md - OAuth 2.0、S2S OAuth、JWT模式
- references/app-types.md - 应用类型选择指南
- references/scopes.md - OAuth scopes参考
- references/marketplace.md - 应用市场门户导航
- references/query-routing-playbook.md - 将复杂查询路由到正确的专用skill
- references/interview-answer-routing.md - 适用于面试场景的zoom-general路由简短回答模式
- references/routing-implementation.md - 具体的TypeScript查询分类和skill交接合约
- references/automatic-skill-chaining-rest-webhooks.md - REST + webhook链路工作流的可执行流程
- references/meeting-webhooks-oauth-refresh-orchestration.md - 会议创建 + webhook更新 + OAuth令牌刷新的具体设计
- references/distributed-meeting-fallback-architecture.md - 带重试、熔断、对账降级的高并发分布式架构
- references/community-repos.md - 按产品分类的精选官方Zoom示例仓库
SDK Maintenance
SDK维护
- references/sdk-upgrade-guide.md - Version policy, upgrade steps
- references/sdk-upgrade-workflow.md - Changelog + RSS, version-by-version reusable upgrade workflow
- references/sdk-logs-troubleshooting.md - Collecting SDK logs
- references/sdk-upgrade-guide.md - 版本政策、升级步骤
- references/sdk-upgrade-workflow.md - 更新日志 + RSS、逐版本可复用升级工作流
- references/sdk-logs-troubleshooting.md - SDK日志采集
Resources
资源
- Official docs: https://developers.zoom.us/
- Marketplace: https://marketplace.zoom.us/
- Developer forum: https://devforum.zoom.us/
- 官方文档: https://developers.zoom.us/
- 应用市场: https://marketplace.zoom.us/
- 开发者论坛: https://devforum.zoom.us/
Environment Variables
环境变量
- See references/environment-variables.md for standardized keys and where to find each value.
.env
- 标准化键名和各值获取方式请参考references/environment-variables.md
.env
Operations
运维相关
- RUNBOOK.md - 5-minute preflight and debugging checklist.
- RUNBOOK.md - 5分钟预检和调试检查清单