Skip to main content
このガイドでは、Comdesk Open API への最初のリクエストを順を追って説明します。最後には、コードから発信を行い、その結果が Webhook に届くところまで確認できます。

はじめる前に

API キーが必要です。キーは開発者ではなく、テナント管理者設定 → Open API → API キー で発行します。必要なスコープ(このクイックスタートでは calls:initiate)を持つキーを管理者に依頼してください。
まずはテストキー(cdsk_test_…)から始めましょう。テストキーは実際の電話発信を行わないため、連携を安全に組み立てるのに最適です。本番キー(cdsk_live_…)への切り替えは、UAT 通過後に行ってください。
1

API キーを取得する

管理者が 設定 → Open API → API キー → 新しい API キーを発行 を開き、calls:initiate スコープを選択し、テストを選んでキーをコピーします。平文のキーは一度だけ表示されます。
2

Authorization ヘッダーを設定する

すべてのリクエストでキーを Bearer トークンとして送信します:
3

発信する

顧客の電話番号、発信するスタッフ、プロジェクトを指定して POST /api/v1/calls/initiate を呼び出します。
4

レスポンスを読む

成功すると、新しい通話の ID とステータスが返ります:
レスポンスヘッダーの X-Request-ID に注目してください。デバッグ用に保管します(エラー を参照)。
5

レスポンスを読む

成功すると、新しい通話の ID とステータスが返ります:
レスポンスヘッダーの X-Request-ID に注目してください。デバッグ用に保管します(エラー を参照)。
6

Webhook で結果を受け取る

通話が完了すると、Comdesk は登録済みの Webhook URL に call.completed イベントを送信します。POST /api/v1/webhooks で登録し、受信時に X-Comdesk-Signature を検証してください — Webhook を参照。
7

Webhook で結果を受け取る

通話が完了すると、Comdesk は登録済みの Webhook URL に call.completed イベントを送信します。POST /api/v1/webhooks で登録し、受信時に X-Comdesk-Signature を検証してください — Webhook を参照。

次に読む

認証

スコープ、キーの種類、IP 許可リストを詳しく解説。

通話 API

発信と通話取得の全パラメータ。

Webhook

イベントの購読とエンドポイントの保護。

エラー

エラーエンベロープと各コードの処理方法。