AutoGineer
Generated banner for Build Zoom Phone Integration
Generated logo for Build Zoom Phone Integration

Build Zoom Phone Integration

AnthropicOfficialCreated by ZoomDistributed by Anthropic

  • Skill
  • Tool integration
  • Automation and integrations
  • MIT
  • No issues found
Download ZIP

From the author

Reference skill for Zoom Phone. Use after routing to a phone workflow when implementing OAuth, Phone APIs, webhooks, Smart Embed events, URI schemes, CRM or CTI dialers, or call handling automation.
— the description by Zoom

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides architectural guidance and implementation patterns for developers building integrations with Zoom Phone. It covers the full lifecycle of phone-related integrations, including OAuth authentication, handling real-time events via webhooks, embedding softphone functionality in web applications, and automating call-handling settings. It serves as a central hub for navigating documentation, migration paths, and common integration scenarios like CRM softphone panes or click-to-dial functionality.

What it does

  • Provides architectural patterns for Zoom Phone integrations.
  • Offers guidance on choosing between Smart Embed, REST APIs, and URI schemes.
  • Details the lifecycle for provisioning, authentication, and event handling.
  • Includes patterns for call handling, analytics, and CRM integration.
  • Provides troubleshooting and migration advice for legacy call logs.
  • Links to standardized environment variable configurations.

When to use it

  • When building a CRM or web application that requires embedded softphone capabilities.
  • When automating call handling settings for users, auto-receptionists, or call queues.
  • When implementing click-to-dial or click-to-SMS features in external interfaces.
  • When setting up real-time operational dashboards using phone webhooks.
  • When migrating from legacy call logs to modern call history and element APIs.

Advantages

  • Centralizes complex integration documentation and best practices.
  • Provides clear routing guardrails to select the right integration surface.
  • Includes practical patterns for handling OAuth and event validation.
  • Offers guidance on avoiding common pitfalls in API payload structures.
  • Supports migration-safe data mapping for evolving API schemas.

Usage examples

“How do I implement a click-to-dial feature in my web app for Zoom Phone?”
The agent will guide you to use URI schemes like zoomphonecall:// and explain how to trigger them from your UI.
“What is the best way to embed a softphone in my CRM?”
The agent will recommend the Smart Embed approach, providing details on using iframes and the postMessage bridge for communication.
“How do I automate call handling settings for an auto-receptionist?”
The agent will provide the REST API pattern for reading and patching call handling settings, including validation tips.
“I need to track call events in real-time. Where do I start?”
The agent will direct you to the webhook and Smart Embed event documentation to capture and correlate call identifiers.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/anthropics/build-zoom-phone-integration/download

  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip build-zoom-phone-integration.zip -d .agents/skills

Documentation by Zoom

/build-zoom-phone-integration

Background reference for Zoom Phone integrations across API, webhook, Smart Embed, and URI-launch workflows.

Implementation guidance for Zoom Phone integrations across API, webhook/event, Smart Embed, and URI-launch workflows.

Official docs:

Routing Guardrail

  • If the user needs embedded softphone behavior in a web app, use Smart Embed (examples/smart-embed-postmessage-bridge.md).

  • If the user needs call records, analytics, or automation, use Phone REST API and webhooks (references/deprecations-and-migrations.md).

  • If the user needs click-to-dial/SMS launch from external UI, use URI schemes (zoomphonecall://, zoomphonesms://).

  • If the user mixes Zoom Phone and Contact Center, chain with ../contact-center/SKILL.md.

Quick Links

Start here:

  1. concepts/architecture-and-lifecycle.md

  2. scenarios/high-level-scenarios.md

  3. references/deprecations-and-migrations.md

  4. references/forum-top-questions.md

  5. references/smart-embed-event-contract.md

  6. references/call-handling-patterns.md

  7. references/environment-variables.md

  8. references/crm-sample-validation.md

  9. troubleshooting/common-issues.md

  10. RUNBOOK.md

  11. examples/smart-embed-postmessage-bridge.md

  12. examples/phone-api-service-pattern.md

  13. references/source-map.md

Common Lifecycle Pattern

  1. Provision account prerequisites (Zoom Phone license, admin setup, SMS readiness).

  2. Create OAuth app and scopes in Marketplace.

  3. Choose integration surface:

  • Smart Embed (iframe + postMessage)

  • REST + webhooks

  • URI launch (callto, tel, zoomphonecall, zoomphonesms)

  1. Capture real-time events (Smart Embed events and/or webhooks).

  2. Persist call identifiers and correlate records (call_id, call_history_uuid, call_element_id).

  3. Apply migration-safe data mapping (v1 -> v2 -> v3) and handle renamed fields.

  4. Harden security (origin validation, webhook signature validation, least-privilege scopes).

High-Level Scenarios

  • CRM softphone pane using Smart Embed + contact search/match callbacks.

  • Click-to-call from account/contact table via zp-make-call.

  • Call disposition workflow using zp-save-log-event and custom notes page.

  • SMS engagement workflow with zoomphonesms:// and zp-sms-log-event.

  • Real-time operational board driven by phone.* webhook events.

  • Call analytics migration from legacy call logs to call history/call elements.

  • Admin automation for user/auto-receptionist/call-queue call-handling settings.

See scenarios/high-level-scenarios.md for details.

Chaining

  • OAuth setup/token lifecycle: ../oauth/SKILL.md

  • Phone and account resources via REST: ../rest-api/SKILL.md

  • Event delivery and signature validation: ../webhooks/SKILL.md

  • Contact Center blended journey: ../contact-center/SKILL.md

Environment Variables

Files

concepts/architecture-and-lifecycle.md

Zoom Phone Architecture and Lifecycle

Architecture

User/Agent UI
  |
  | (A) Smart Embed postMessage events
  v
Smart Embed Iframe (applications.zoom.us)
  |
  | event stream + call controls
  v
CRM Web App (event bridge + UI state)
  |
  | OAuth token on server only
  v
Backend API Layer
  |\
  | \-- Zoom Phone REST APIs (call history, call handling, contacts)
  |
  \---- Webhook endpoint (phone.* events)

Lifecycle Workflow

  1. Provision:

  • Account has Zoom Phone and optional SMS enablement.

  1. Authorize:

  • OAuth app installed and scoped for required Phone operations.

  1. Initialize UI:

  • Load Smart Embed iframe/script.

  • Wait for onZoomPhoneIframeApiReady.

  • Send zp-init-config and register event handlers.

  1. Engage:

  • Start calls/SMS via zp-make-call or zp-input-sms.

  • Receive events (zp-call-*, zp-sms-log-event, optional AI/contact/notes events).

  1. Persist:

  • Save event snapshots keyed by callId.

  • Reconcile to call history/call element records after completion.

  1. Post-call:

  • Save call notes/disposition and optional recording/voicemail links.

  1. Operate:

  • Track deprecations and apply endpoint/event mapping updates.

Version Drift Strategy

  • Normalize inbound payloads in one adapter layer.

  • Keep endpoint constants centralized by version target.

  • Feature-flag optional payload fields.

  • Keep webhook + Smart Embed event handlers tolerant to added fields and enum expansion.

Requirements and compatibility

Written for: Claude Code, Claude apps

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
Zoom
Publisher
Anthropic (Official)
Distributed by
Anthropic
Source
anthropics/knowledge-work-plugins · partner-built/zoom-plugin/skills/phone · commit e050c2e
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from partner-built/zoom-plugin/LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Zoom or Anthropic.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download build-zoom-phone-integration.zip