コールバック呼び出し API

コールバック通話とは、エンドユーザーがリクエストした通話のことです。コールバック呼び出し API を使用すると、コールバック呼び出しをプログラムでスケジュール設定したり、スケジュール設定された呼び出しをキャンセルしたりできます。これらの機能を使用すると、エンドユーザーが指定したキューからコールバックをリクエストできるアプリケーションを作成できます。エンドユーザーは、以前にスケジュールした通話をキャンセルすることもできます。コールバック呼び出し API を使用した認証については、Basic 認証をご覧ください。

コールバック呼び出し API を使用する

コールバック呼び出し API を使用して、コールバック呼び出しをスケジュール設定したり、スケジュール設定された呼び出しをキャンセルしたりできます。

電話相談を予約する

通話のスケジュールを設定するには、POST https://<subdomain>.<domain>/apps/api/v1/calls を呼び出し、次のようなリクエスト本文を含めます。

{
    "call_type": "ScheduledCall",
    "menu_id": 12345,
    "end_user_number": "+18005550100",
    "scheduled_at": "2025-09-02T14:30:00Z"
}

リクエストが成功すると、通話 ID を含む通話オブジェクトが返されます。

スケジュール設定した通話をキャンセルする

スケジュール設定した通話をキャンセルするには、PATCH https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/{id}/cancel を呼び出します。キャンセルする呼び出しの ID を指定します。

リクエストが成功すると、キャンセルされた通話に関する情報が返されます。

複数のスケジュール設定された通話をキャンセルする

複数のスケジュール設定された通話をキャンセルするには、PATCH https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/cancel を呼び出します。キャンセルする通話の通話 ID の call_ids 配列を含むリクエスト本文を含めます。

次のコードサンプルを参照してください。

{
    "call_ids": [123, 456, 789]
}

リクエストが成功すると、キャンセルステータスを確認するための Location URL を含むレスポンスヘッダーを含むレスポンスが返されます。

CRM でコールバック通話を使用する

コールバック呼び出し API は、Salesforce、Zendesk、ServiceNow CRM との統合で使用できます。

一般的なコールバックの動作

サポートされている CRM（Salesforce、Zendesk、ServiceNow）を使用している場合、次の条件がスケジュール設定されたコールバックの動作に影響します。

レコードがオープンで、すでに有効なスケジュール設定された通話がある: チケット ID の検索で、レコードがオープンで、すでに有効なスケジュール設定された通話があることが示された場合、通話はスケジュール設定されません。次のコメントが CRM レコードに添付されます: A scheduled call was not created because the record already has an active scheduled call。
CRM にアクセスできない: チケット ID のルックアップで CRM にアクセスできないことが示された場合、通話はキャンセルされます。次のコメントが CRM レコードに添付されます: A scheduled call was canceled because the CRM was unreachable。

クローズされたレコードでのコールバックの動作

クローズされたレコードのコールバック通話の処理方法は、使用している CRM によって異なります。

Zendesk と ServiceNow のユーザー: チケット ID の検索でレコードがクローズされていることが示された場合、通話はスケジュールされません。次のコメントが CRM レコード A scheduled call was not created because the record is closed に添付されています。
Salesforce ユーザー: Salesforce でのコールバック通話を参照して、インスタンスでクローズされたレコードのスケジュール設定された通話を処理する方法を構成します。

Salesforce でのコールバック通話

CCAI Platform を Salesforce と統合している場合は、インスタンスがクローズされたレコードのスケジュールされた通話を処理する方法を構成できます。Salesforce 統合の構成オプションは次のとおりです。

レコードのステータスを確認しない。
レコードのステータスを確認し、クローズされたレコードを再度開きます。
レコードのステータスを確認し、クローズされたレコードのスケジュール設定された通話をキャンセルします。

レコードのステータスを確認しない

CCAI Platform を構成して、スケジュールされた通話を行う前にレコードのステータスを確認しないようにすることができます。この構成では、レコードが開いているか閉じているかに関係なく、スケジュールどおりに電話がかけられます。

レコードのステータスを確認しないように CCAI プラットフォームを構成する手順は次のとおりです。

CCAI Platform ポータルで、[設定] > [運用管理] をクリックします。[設定] メニューが表示されない場合は、 [メニュー] をクリックします。
[CRM Record Creation Details] > [Closed record options when initiating an API-scheduled call] に移動します。
[レコードのステータスを確認しない。API スケジュール設定された呼び出しを常に開始します。
[Save General] をクリックします。

レコードのステータスを確認し、クローズされたレコードを再度開く

CCAI Platform を構成して、スケジュールされた通話を行う前にレコードのステータスを確認し、クローズされたレコードを再度開くことができます。この構成では、レコードのステータスが [Closed] の場合、次の処理が行われます。

通話はスケジュールどおりに行われます。
レコードが再度開きます。
次のコメントが CRM レコードに添付されています: The record was reopened at the time of a scheduled call。

CCAI Platform でレコードのステータスを確認し、クローズされたレコードを再度開くように構成する手順は次のとおりです。

CCAI Platform ポータルで、[設定] > [運用管理] をクリックします。[設定] メニューが表示されない場合は、 [メニュー] をクリックします。
[CRM Record Creation Details] > [Closed record options when initiating an API-scheduled call] に移動します。
[Check the record status]（レコードのステータスを確認）を選択します。レコードが閉じている場合 > レコードを再度開きます。
[Save General] をクリックします。

レコードのステータスを確認し、クローズされたレコードのスケジュールされた通話をキャンセルする

CCAI Platform を構成して、スケジュールされた通話を行う前にレコードのステータスを確認し、クローズされたレコードのスケジュールされた通話をキャンセルできます。この構成では、レコードのステータスが [Closed] の場合、次のアクションが実行されます。

スケジュールされた通話はキャンセルされます。
次のコメントが CRM レコードに添付されています: A scheduled call was canceled because the record is closed。

CCAI Platform を構成して、レコードのステータスを確認し、クローズされたレコードのスケジュール設定された通話をキャンセルする手順は次のとおりです。

CCAI Platform ポータルで、[設定] > [運用管理] をクリックします。[設定] メニューが表示されない場合は、 [メニュー] をクリックします。
[CRM Record Creation Details] > [Closed record options when initiating an API-scheduled call] に移動します。
[Check the record status]（レコードのステータスを確認）を選択します。レコードがクローズされている場合 > 予定されているコールをキャンセルします。
[Save General] をクリックします。

コールバック呼び出し API コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。