build-zoom-virtual-agent

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

/build-zoom-virtual-agent

/build-zoom-virtual-agent

Background reference for Zoom Virtual Agent across:
  • Web campaign/chat embeds.
  • Android WebView wrappers.
  • iOS WKWebView wrappers.
  • Knowledge-base sync and custom API ingestion.
Official docs:
Zoom Virtual Agent的背景参考,覆盖以下场景:
  • 网页活动/聊天嵌入。
  • Android WebView包装器。
  • iOS WKWebView包装器。
  • 知识库同步与自定义API接入。
官方文档:

Routing Guardrail

路由规则

  • If the user is implementing Contact Center app surfaces inside Zoom client, chain with ../contact-center/SKILL.md.
  • If the user needs backend knowledge-base CRUD or automation scripts, chain with ../rest-api/SKILL.md and ../oauth/SKILL.md.
  • If the user asks only for website bot embed and campaign controls, stay on web/SKILL.md.
  • If the user asks for mobile native wrappers around web chat, route to android/SKILL.md or ios/SKILL.md.
  • 如果用户正在Zoom客户端内实现联络中心应用界面,关联到 ../contact-center/SKILL.md
  • 如果用户需要后端知识库CRUD或自动化脚本,关联到 ../rest-api/SKILL.md../oauth/SKILL.md
  • 如果用户仅询问网站机器人嵌入和活动管控,停留在 web/SKILL.md
  • 如果用户询问网页聊天的移动端原生包装器,路由到 android/SKILL.mdios/SKILL.md

Quick Links

快速链接

  1. concepts/architecture-and-lifecycle.md
  2. scenarios/high-level-scenarios.md
  3. references/versioning-and-drift.md
  4. references/samples-validation.md
  5. references/environment-variables.md
  6. troubleshooting/common-drift-and-breaks.md
  7. RUNBOOK.md
Platform skills:
  • web/SKILL.md
  • android/SKILL.md
  • ios/SKILL.md
  1. concepts/architecture-and-lifecycle.md
  2. scenarios/high-level-scenarios.md
  3. references/versioning-and-drift.md
  4. references/samples-validation.md
  5. references/environment-variables.md
  6. troubleshooting/common-drift-and-breaks.md
  7. RUNBOOK.md
平台技能:
  • web/SKILL.md
  • android/SKILL.md
  • ios/SKILL.md

Common Lifecycle Pattern

通用生命周期模式

  1. Configure campaign or entry ID in Virtual Agent admin.
  2. Initialize SDK in web or WebView container.
  3. Wait for readiness (
    zoomCampaignSdk:ready
    or
    waitForReady()
    ) before calling APIs.
  4. Register bridge handlers (
    exitHandler
    ,
    commonHandler
    ,
    support_handoff
    ) when native orchestration is needed.
  5. Handle conversation lifecycle (
    engagement_started
    ,
    engagement_ended
    ) and UI state.
  6. End chat (
    endChat
    ) and clean up listeners.
  1. 在Virtual Agent管理后台配置活动或入口ID。
  2. 在网页或WebView容器中初始化SDK。
  3. 调用API前等待就绪(
    zoomCampaignSdk:ready
    waitForReady()
    )。
  4. 需要原生编排时注册桥接处理器(
    exitHandler
    commonHandler
    support_handoff
    )。
  5. 处理会话生命周期(
    engagement_started
    engagement_ended
    )和UI状态。
  6. 结束聊天(
    endChat
    )并清理监听器。

High-Level Scenarios

高层场景

  • Website campaign launcher with contextual customer attributes.
  • Mobile app WebView chat with native close/handoff bridge.
  • External URL handling via system browser vs in-app browser policy.
  • Knowledge-base sync from external systems using custom API connector.
  • Cross-team support flow that escalates from bot to live support with handoff payload.
  • 携带上下文客户属性的网站活动启动器。
  • 具备原生关闭/转接桥接能力的移动应用WebView聊天。
  • 通过系统浏览器和应用内浏览器策略处理外部URL。
  • 使用自定义API连接器从外部系统同步知识库。
  • 从机器人升级到人工在线支持并携带转接 payload 的跨团队支持流程。

Chaining

关联技能

  • Contact Center app/web/mobile patterns: ../contact-center/SKILL.md
  • OAuth app setup and tokens: ../oauth/SKILL.md
  • API workflows for KB automation: ../rest-api/SKILL.md
  • Event-driven backend follow-up: ../webhooks/SKILL.md
  • 联络中心应用/网页/移动端模式:../contact-center/SKILL.md
  • OAuth应用配置与令牌:../oauth/SKILL.md
  • 知识库自动化的API工作流:../rest-api/SKILL.md
  • 事件驱动的后端后续处理:../webhooks/SKILL.md

Operations

运维操作

  • RUNBOOK.md - 5-minute preflight and debugging checklist.
  • RUNBOOK.md - 5分钟预检查与调试清单。