Setting the file. One moment. RUNBOOK · Build Zoom Contact Center App · anthropics/knowledge-work-plugins · Skills Docs
Use this before deep debugging. It catches the most common Zoom Contact Center integration failures quickly.
22
Validate Data
Tech Debt
62
Recruiting Pipeline
71
Vendor Check
125
Zoom Meeting SDK Web
88
Vendor Review
181
Create An Asset
Video Sdk/web
109.4
Versioning And Compatibility
- Skill entrypoint is
SKILL.md.
- This runbook is an operational convention (recommended), not a required skill file.
SKILL.md is a navigation convention for larger skill docs.
- Contact Center app inside Zoom client: use Zoom Apps SDK APIs/events (
getEngagementContext, onEngagementStatusChange, etc.).
- Website embed: use Contact Center web SDK/campaign script path.
- Native mobile app: use Android/iOS Contact Center SDK binaries and service lifecycle.
Wrong path is the top source of confusion.
entryId for chat/video/ZVA channels.
apiKey for scheduled callback and campaign/web-tag scenarios.
- If building a Contact Center app in Zoom client, validate app credentials and OAuth setup in Marketplace.
Common native/mobile order:
- Initialize SDK context early.
- Get service instance.
- Initialize service with
ZoomCCItem.
- Register listener/delegate.
login() where required (typically chat/ZVA).
fetchUI() to present the channel view.
zoomSdk.config(...)
getEngagementContext() and getEngagementStatus()
- subscribe to
onEngagementContextChange and onEngagementStatusChange
- persist state keyed by
engagementId
- A single app instance can receive multiple engagement contexts.
- Persist draft/workflow state by
engagementId.
- Do not assume only one active engagement for chat/SMS/email workflows.
- End action (
endChat, endVideo, endScheduledCallback) is not the same as service release.
- Apply platform-specific cleanup (
logout/logoff, release/uninitialize APIs).
- On iOS, forward app lifecycle callbacks (
appDidBecomeActive, appWillTerminate, etc.) to ZoomCCInterface.
- Zoom enforces minimum SDK versions quarterly (first weekend of February, May, August, November).
- Re-check docs and changelog before release; naming and signatures can drift.
- Watch deprecations:
- iOS
onService:error:detail: is deprecated in favor of onService:error:detail:description:.
- App context/status APIs return valid values.
- Engagement events fire when agent switches engagements.
- Chat/video/scheduled callback can be started and ended once each without stale state.
- No CSP or domain allow-list blocks for web integrations.
- No engagement data in Contact Center app -> missing SDK
config capabilities or wrong runtime context.
- Channel UI does not open -> invalid
entryId/apiKey, missing init, or wrong service/channel mapping.
- Events not firing on switch/end -> listeners not attached early enough or removed incorrectly.
- Rejoin fails on mobile -> deep-link/scheme configuration mismatch.
RUNBOOK.md