build zoom phone integration

Skill

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.

Files14
  • @skills/phone/RUNBOOK.md
  • @skills/phone/SKILL.md
  • @skills/phone/concepts/architecture-and-lifecycle.md
  • @skills/phone/examples/phone-api-service-pattern.md
  • @skills/phone/examples/smart-embed-postmessage-bridge.md
  • @skills/phone/references/call-handling-patterns.md
  • @skills/phone/references/crm-sample-validation.md
  • @skills/phone/references/deprecations-and-migrations.md
  • @skills/phone/references/environment-variables.md
  • @skills/phone/references/forum-top-questions.md
  • @skills/phone/references/smart-embed-event-contract.md
  • @skills/phone/references/source-map.md
  • @skills/phone/scenarios/high-level-scenarios.md
  • @skills/phone/troubleshooting/common-issues.md

/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 [blocked]).
  • If the user needs call records, analytics, or automation, use Phone REST API and webhooks (references/deprecations-and-migrations.md [blocked]).
  • 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 [blocked]
  2. scenarios/high-level-scenarios.md [blocked]
  3. references/deprecations-and-migrations.md [blocked]
  4. references/forum-top-questions.md [blocked]
  5. references/smart-embed-event-contract.md [blocked]
  6. references/call-handling-patterns.md [blocked]
  7. references/environment-variables.md [blocked]
  8. references/crm-sample-validation.md [blocked]
  9. troubleshooting/common-issues.md [blocked]
  10. RUNBOOK.md [blocked]
  11. examples/smart-embed-postmessage-bridge.md [blocked]
  12. examples/phone-api-service-pattern.md [blocked]
  13. references/source-map.md [blocked]

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 [blocked] for details.

Chaining

Environment Variables

  • See references/environment-variables.md [blocked] for standardized .env keys and where to find each value.
build-zoom-phone-integration — Kortix Marketplace | Kortix