Skip to main content
Open API機能は現在開発中であり、今後リリースを予定しております。本ドキュメントは事前公開版のため、正式リリースまでに仕様や内容が変更される場合があります。最新情報は本ヘルプページをご確認ください。
Comdesk Lead Open API を使うと、アプリケーションから Comdesk と直接やり取りできます。CRM・BI・チャット・AI ツールを開発する場合、発信の実行、通話履歴の取得（AI による文字起こし・要約を含む）、顧客の一括登録、リアルタイムな Webhook イベントの購読が可能です。すべて、API キーとスコープで保護された標準的な REST インターフェースで提供されます。 このドキュメントは、外部システムを Comdesk テナントに連携する開発者向けです。管理画面から API キーを発行・管理する方法については、ビジネス向けガイドブックを参照してください。

​
できること

クリックして発信

POST /calls/initiate で CRM から発信をトリガーします。

通話履歴の同期

完了した通話を取得・ストリーミング — メタデータ、メモ、文字起こし、AI 要約、音声分析、録音 URL。

顧客インポート

単一または一括（最大 500 件）で顧客を登録。external_id で相互参照できます。

レポートと BI

Power BI・Tableau・Looker 向けに集計済みの通話統計を取得します。

​
仕組み

すべてのリクエストは API キーで認証され、そのキーに付与されたスコープで権限を確認し、テナント単位でレート制限を適用し、相関 ID X-Request-ID とともに記録されます。Comdesk は署名付き Webhook でイベントをあなたのエンドポイントに送信します。

​
前提条件

  • open_api または open_api_advanced ライセンスを持つ Comdesk Lead テナント。
  • テナント管理者が発行した API キー（認証 を参照）。
  • Webhook を使う場合：POST リクエストを受信できる HTTPS エンドポイント。
Webhook、レポート API、カスタムレート制限、IVR トリガーは open_api_advanced ライセンスが必要です。プラン比較は レート制限とクォータ を参照してください。

​
ベース URL

すべての v1 エンドポイントは次の配下で提供されます：
上記の本番ホストは Comdesk プラットフォームチームによる確認待ちです。本番稼働前に、ご利用環境の正確なベース URL をご確認ください。

​
次のステップ

クイックスタート

5 分で最初の認証付きリクエストを実行します。

認証

API キーの形式、Bearer ヘッダー、スコープ、IP 許可リスト。

API リファレンス

すべてのエンドポイント、パラメータ、レスポンスフィールド。

Webhook

イベントを購読し、署名を検証します。