用途:为在 Zoom 客户端内运行的网页应用提供参考,包括会议、网络研讨会、主客户端和 Zoom Phone。建议先选择 Zoom 方案,再查阅本技能了解 Layers API、协作模式、客户端内 OAuth 和运行时约束。
主要能力:@zoom/appssdk 提供 JavaScript API,涵盖上下文 API(会议、用户、参会者信息)、会议操作(共享应用、邀请参会者、打开 URL)、客户端内 OAuth(PKCE,无需浏览器跳转)、Layers API(沉浸式视频布局与摄像头叠加)、协作模式(跨参会者共享状态)、应用通信(实例间消息传递)、媒体控制(虚拟背景、摄像头列表、录制控制)、UI 控制(展开应用、通知、弹出)以及事件监听。
使用方式:满足前置条件(在 Marketplace 配置为 Zoom App 类型、OAuth 凭据与 Zoom Apps 作用域、Web 应用、域名白名单、本地开发用 ngrok 或 HTTPS 隧道、Node.js 18+)。可用 npm 安装 @zoom/appssdk,或通过 CDN 引入 https://appssdk.zoom.us/sdk.js。任何其他 SDK 方法前必须先调用 config() 并列出所需能力,能力需与 Marketplace 中的 OAuth 作用域匹配。
适用场景:会议侧边栏、主客户端面板、网络研讨会、沉浸式渲染、摄像头模式、协作模式、Zoom Phone、团队聊天等。
限制:SDK 仅在 Zoom 客户端内可用,外部浏览器调用 sdk.config() 会报错,需 try/catch 并提供回退界面;域名必须在 Marketplace 白名单中,否则面板空白无提示;使用 CDN 时不要用 let 重复声明 zoomSdk,否则会触发 SyntaxError;免费 ngrok 地址重启会变化,需同步更新 Marketplace 中四处配置;客户端内 OAuth 需校验 state 防止 CSRF;摄像头模式存在 CEF 初始化竞态,可能需重试;嵌入式浏览器要求 Cookie 使用 SameSite=None 和 Secure=true。上述信息之外的功能、收费或价格资料暂未提供。