CML Webhook

Webhook を使用すると、アプリケーションはコールイベントデータを受信し、CML アクションを返すことができます。コールマークアップ言語では、同期と非同期の 2 種類の Webhook が使用されます。

同期 Webhook

同期 Webhook では、NTT CPaaS プラットフォームが Webhook URL にリクエストを送信します。Webhook は、200 OK ステータスコードと、次に実行する CML アクションを含む応答ペイロードで応答する必要があります。

すべての同期 Webhook リクエストには、callId、from、to、direction、endpoint、および startTime のフィールドを持つ基本ペイロードが含まれます。Webhook 要求をトリガーした CML アクションに応じて、ベースペイロードに追加データが含まれます。

次の同期 Webhook コールバックを使用できます。

エラーコールバック: 同期コールバック URL に到達できない場合、または不正な形式の CML アクションを返した場合にトリガーされます。エラーコードとエラーの詳細をベースペイロードに追加します。エラーコールバック API リファレンスを参照してください。
コールバックの録音: NTT CPaaS プラットフォームが「録音」アクションによって生成された通話録音を停止したときにトリガーされます。記録ファイル ID と記録ステータスをベースペイロードに追加します。レコード・コールバック API リファレンスを参照してください。
キャプチャ DTMF コールバック: captureDtmf アクションによってトリガーされます。キャプチャされた DTMF ディジットをベースペイロードに追加します。キャプチャ DTMF コールバック API リファレンスを参照してください。
Fetch コールバック: fetch アクションによってトリガーされます。基本ペイロードにデータを追加しません。 fetch コールバック API リファレンスを参照してください。
マシン検出コールバック: 同期マシン検出を使用するアウトバウンドコールを作成するときにトリガーされます。簡略化された検出結果 (機械または人間) と詳細な検出結果 (検出クラスごとの信頼度スコアの配列) を基本ペイロードに追加します。マシン検出コールバック API リファレンスを参照してください。
ダイヤルコールバック: 「ダイヤル」アクションを使用するとトリガーされます。ダイヤル命令に関連するデータを基本ペイロードに追加します。ダイヤルコールバックAPIリファレンスを参照してください。

非同期 Webhook

非同期 Webhook は情報提供のみを目的としています。NTT CPaaS プラットフォームは Webhook URL にリクエストを送信し、Webhook は応答ペイロードなしで 200 OK ステータスコードで応答する必要があります。応答で CML アクションを返さないでください。

すべての非同期 Webhook 要求には、同期 Webhook と同じ基本ペイロード (callId、from、to、direction、endpoint、startTime) が含まれます。イベントによっては、基本ペイロードに追加データが含まれます。

次の非同期 Webhook コールバックを使用できます。

マシン検出非同期コールバック: 非同期マシン検出を使用するアウトバウンドコールを作成するときにトリガーされます。簡略化された検出結果 (機械または人間) と詳細な検出結果 (検出クラスごとの信頼度スコアの配列) を基本ペイロードに追加します。マシン検出の非同期コールバック API リファレンスを参照してください。
マシンメッセージ検出の非同期コールバック: メッセージの終了検出を有効にして非同期マシン検出を使用するアウトバウンドコールを作成するときにトリガーされます。メッセージ検出の終了をトリガーした原因に関する情報をベースペイロードに追加します。マシンメッセージ検出の非同期コールバック API リファレンスを参照してください。
記録ステータスコールバック: startRecordingアクションを使用するとトリガーされます。記録ファイル ID と記録ステータスをベースペイロードに追加します。記録ステータスコールバック API リファレンスを参照してください。