Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

コールバック呼び出し 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 プラットフォームを Salesforce と統合している場合は、インスタンスでクローズされたレコードのスケジュール設定された通話を処理する方法を構成できます。Salesforce 統合の構成オプションは次のとおりです。

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

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

スケジュール設定された通話を行う前にレコードのステータスを確認しないように CCAI プラットフォームを構成できます。この構成では、レコードが開いているか閉じているかに関係なく、通話はスケジュールどおりに行われます。

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

CCAI プラットフォームポータルで、[設定 > オペレーション管理] をクリックします。[**設定**] メニューが表示されない場合は、 [メニュー] をクリックします。
[CRM レコード作成の詳細]> [API スケジュール設定された通話の開始時のクローズされたレコードオプション] に移動します。
[レコードのステータスを確認しない。常に API スケジュール設定された通話を開始する] を選択します。
[全般を保存] をクリックします。

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

スケジュール設定された通話を行う前にレコードのステータスを確認し、クローズされたレコードを再度開くように CCAI プラットフォームを構成できます。この構成では、レコードのステータスがクローズされている場合、次の処理が行われます。

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

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

CCAI プラットフォームポータルで、[設定 > オペレーション管理] をクリックします。[**設定**] メニューが表示されない場合は、 [メニュー] をクリックします。
[CRM レコード作成の詳細]> [API スケジュール設定された通話の開始時のクローズされたレコードオプション] に移動します。
[レコードのステータスを確認する。レコードがクローズされている場合 > レコードを再度開く。
[全般を保存] をクリックします。

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

スケジュール設定された通話を行う前にレコードのステータスを確認し、クローズされたレコードのスケジュール設定された通話をキャンセルするように CCAI プラットフォームを構成できます。この構成では、レコードのステータスがクローズされている場合、次の処理が行われます。

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

レコードのステータスを確認し、クローズされたレコードのスケジュール設定された通話をキャンセルするように CCAI プラットフォームを構成する手順は次のとおりです。

CCAI プラットフォームポータルで、[設定 > オペレーション管理] をクリックします。[**設定**] メニューが表示されない場合は、 [メニュー] をクリックします。
[CRM レコード作成の詳細]> [API スケジュール設定された通話の開始時のクローズされたレコードオプション] に移動します。
[レコードのステータスを確認する。レコードがクローズされている場合 > スケジュール設定された通話をキャンセルする。
[全般を保存] をクリックします。

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