/build-zoom-phone-integration

Zoom Phone インテグレーションに関する背景参考資料です。API、ウェブフック、Smart Embed、URI起動ワークフロー全体をカバーします。

Zoom Phone インテグレーション実装ガイダンスです。API、ウェブフック/イベント、Smart Embed、URI起動ワークフロー全体に対応しています。

公式ドキュメント:

• https://developers.zoom.us/docs/phone/
• CRM サンプルリファレンス: https://github.com/zoom/CRM-Sample

ルーティングガイドライン

• ウェブアプリで組み込みソフトフォン動作が必要な場合は、Smart Embed を使用してください (examples/smart-embed-postmessage-bridge.md)。
• 通話記録、分析、または自動化が必要な場合は、Phone REST API とウェブフックを使用してください (references/deprecations-and-migrations.md)。
• 外部 UI からのクリック‐ツー‐ダイヤル/SMS 起動が必要な場合は、URI スキーム (zoomphonecall://, zoomphonesms://) を使用してください。
• Zoom Phone とコンタクトセンターを組み合わせる場合は、../contact-center/SKILL.md と連携させてください。

クイックリンク

ここから開始してください:

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

一般的なライフサイクルパターン

1. アカウント前提条件をプロビジョニングします (Zoom Phone ライセンス、管理者セットアップ、SMS 対応)。
2. Marketplace で OAuth アプリとスコープを作成します。
3. インテグレーション方法を選択します:
   • Smart Embed (iframe + postMessage)
   • REST + ウェブフック
   • URI 起動 (callto, tel, zoomphonecall, zoomphonesms)
4. リアルタイムイベントをキャプチャします (Smart Embed イベントおよび/またはウェブフック)。
5. 通話識別子を保存し、レコードを相関させます (call_id, call_history_uuid, call_element_id)。
6. マイグレーション対応データマッピング (v1 → v2 → v3) を適用し、名前が変更されたフィールドを処理します。
7. セキュリティを強化します (オリジン検証、ウェブフック署名検証、最小権限スコープ)。

高レベルシナリオ

• Smart Embed + 連絡先検索/一致コールバックを使用した CRM ソフトフォンペイン。
• zp-make-call 経由でアカウント/連絡先テーブルからのクリック‐ツー‐コール。
• zp-save-log-event とカスタムノートページを使用した通話処理フロー。
• zoomphonesms:// と zp-sms-log-event を使用した SMS エンゲージメントワークフロー。
• phone.* ウェブフックイベント駆動のリアルタイム運用ダッシュボード。
• レガシー通話ログから通話履歴/通話要素への通話分析マイグレーション。
• ユーザー/自動受付員/通話キューの通話処理設定に関する管理自動化。

詳細は scenarios/high-level-scenarios.md を参照してください。

チェーニング

• OAuth セットアップ/トークンライフサイクル: ../oauth/SKILL.md
• REST 経由の電話およびアカウントリソース: ../rest-api/SKILL.md
• イベント配信および署名検証: ../webhooks/SKILL.md
• コンタクトセンター統合ジャーニー: ../contact-center/SKILL.md

環境変数

• 標準化された .env キーおよび各値の場所については、references/environment-variables.md を参照してください。