IBM Cloud Docs
CDR ログ・イベント・リファレンス

CDR ログ・イベント・リファレンス

ログ Webhook によって送信される cdr_logged イベントの場合、payload オブジェクトには、電話統合によって処理された発着信詳細記録 (CDR) イベントに関するデータが含まれます。 CDR イベントの payload オブジェクトには、以下のプロパティーが含まれています。

CDR Webhook ペイロード・オブジェクトのプロパティー
プロパティー (Property) タイプ 説明
primary_phone_number ストリング かかってきた電話番号。
global_session_id ストリング 固有のセッション ID。
failure_occurred ブール値 通話中に障害が発生したかどうか。
failure_details ストリング 発生した障害に関する詳細。
transfer_occurred ブール値 通話の転送が試行されたかどうか。
active_calls 数値 呼び出しが開始されたときのアクティブな呼び出しの数。
x-global-sip-trunk-call-id ストリング

最初のSIP INVITE リクエストから抽出されたSIPトランクコールIDヘッダーの値。 次の SIP トランク・コール ID ヘッダーがサポートされます:

  • X-Twilio-CallSid
  • X-SID
  • X-Global-SIP-Trunk-Call-ID
call オブジェクト 通話に関する情報。 call を参照してください。
session_initiation_protocol オブジェクト SIP プロトコル関連の詳細。 session_initiation_protocol を参照してください。
max_response_milliseconds オブジェクト 通話中に使用されるサービスの最大待ち時間。 max_response_milliseconds を参照してください。
assistant_interaction_summaries 配列 通話中に行われた watsonx Assistant 対話に関する詳細。 assistant_interaction_summaries を参照してください。
injected_custom_data オブジェクト cdr_custom_data コンテキスト変数から抽出されたキー/値のペアのセット。
warnings_and_errors 配列 通話中に記録された警告またはエラー。 warnings_and_errors を参照してください。
realtime_transport_network_summary オブジェクト inbound_stream オブジェクトにおけるインバウンド・ストリームの統計、および outbound_stream オブジェクトにおけるアウトバウンド・ストリームの統計。 これは RTCP が有効な場合にのみ含まれます。 realtime_transport_network_summary を参照してください。

call

call オブジェクトには、以下のプロパティが含まれています。

呼び出しオブジェクトのプロパティー
プロパティー (Property) タイプ 説明
start_timestamp ストリング 通話開始時刻をISO形式( yyyy-MM-ddTHH:mm:ss.SSSZ )で入力してください。
stop_timestamp ストリング 通話が終了した時刻をISO形式( yyyy-MM-ddTHH:mm:ss.SSSZ )で入力してください。
milliseconds_elapsed 数値 通話時間(ミリ秒単位)。
end_reason ストリング 呼び出しが終了した理由。 考えられる理由は次のとおりです。
-assistant_transfer
-assistant_hangup
-caller_hangup
-failed
security.media_encrypted ブール値 メディアが暗号化されたかどうか。
security.signaling_encrypted ブール値 SIP シグナリングが暗号化されたかどうか。
security.sip_authenticated ブール値 発信者の認証に SIP 認証が使用されたかどうか。

session_initiation_protocol

session_initiation_protocol オブジェクトには、以下のプロパティが含まれています。

session_initiation_protocol オブジェクトのプロパティー
プロパティー (Property) タイプ 説明
invite_arrival_timestamp ストリング INVITE 要求が到着した時刻 (ISO 形式 (yyyy-MM-ddTHH:mm:ss.SSSZ))。
setup_milliseconds 数値 通話のセットアップに要した時間(ミリ秒単位)。 最初のSIP INVITE リクエストが受信された時点から、最後のSIP ACK リクエストが受信された時点までの時間。
headers.call_id ストリング SIP Call-ID ヘッダーフィールドは、その通話に関連する SIP INVITE から取得されます。
headers.from_uri ストリング 最初のSIP INVITE From ヘッダーからのSIP URI。
headers.to_uri ストリング 最初のSIP INVITE To ヘッダーからのSIP URI。

assistant_interaction_summaries

assistant_interaction_summaries オブジェクトには、以下のプロパティが含まれています。

assistant_interaction_summaries オブジェクトのプロパティー
プロパティー (Property) タイプ 説明
assistant_id ストリング アシスタントの固有の識別子。
session_id ストリング セッションのユニークな識別子。
turns 配列 会話中に行われた watsonx Assistant 対話を記述するオブジェクトの配列。 assistant_interaction_summaries.turns[] を参照してください。

assistant_interaction_summaries.turns[]

assistant_interaction_summaries.turns 配列のオブジェクトには、以下のプロパティが含まれています。

プロパティー (Property) タイプ 説明
assistant.log_id ストリング ログに記録されたイベントの固有 ID。これを使用して、メッセージ・ログと CDR イベントを相関させることができます。
assistant.start_timestamp ストリング ISO形式( yyyy-MM-ddTHH:mm:ss.SSSZ )で、アシスタントにリクエストが送信された時刻。
assistant.response_milliseconds 数値 リクエストが送信されてからアシスタントから応答を受信するまでの時間(ミリ秒単位)。
request オブジェクト アシスタントに送信された要求。 assistant_interaction_summaries.turns[].request を参照してください。
response 配列 要求に関連付けられた response オブジェクトの配列。
{: caption="assistant_interaction_summaries.ターン[] 配列 "caption-side = "top"} 内のオブジェクトのプロパティー

assistant_interaction_summaries.turns[].request

assistant_interaction_summaries.turns[].request オブジェクトには、以下のプロパティが含まれています。

assistant_interaction_summaries.ターン[].request オブジェクトのプロパティー caption-side
プロパティー (Property) タイプ 説明
type ストリング

要求タイプ:

  • start: 初期要求がアシスタントに送信されます
  • speech_to_text: Speech to Text サービスから入力が受信されます
  • dtmf: DTMF 収集が完了します
  • sms: 呼び出し元から SMS メッセージが受信されます
  • post_response_timeout: 応答後のタイマーが期限切れになります
  • redirect: 呼び出しがリダイレクトされます
  • transfer: 呼び出しが転送されます
  • transfer_failed: 通話中転送が失敗する
  • final_utterance_timeout: 最終発話タイマーが期限切れになります
  • no_input_turn: no input turn が有効化されます
  • sms_failure: SMS メッセージを発信者に送信できません
  • speech_to_text_result_filtered: 信頼性レベルが低いため発話がフィルタリングされます
  • mrcp_recognition_unsuccessful: MRCP 認識は最終発話なしで完了します
  • network_warning: ネットワーク・エラーが検出されます
  • media_capability_change: 呼び出し時に媒体機能が変更されます。
streaming_statistics オブジェクト Speech to Textに関する情報および統計。 assistant_interaction_summaries.turns[].request.streaming_statistics を参照してください。
assistant_interaction_summaries.turns[].request.streaming_statistics

assistant_interaction_summaries.turns[].request.streaming_statistics オブジェクトには、以下のプロパティが含まれています。

プロパティー (Property) タイプ 説明
transaction_id ストリング トランザクションの固有の識別子。
start_timestamp ストリング トランザクションが開始された時刻をISO形式( yyyy-MM-ddTHH:mm:ss.SSSZ )で指定します。
stop_timestamp ストリング 取引が終了した時刻をISO形式で入力してください( yyyy-MM-ddTHH:mm:ss.SSSZ )。
response_milliseconds 数値 発信者の発話で無音が検出されてから、アシスタントから最後の結果が受信されるまでの待ち時間 (ミリ秒)。
echo_detected ブール値 エコーが検出されたかどうか。
confidence 数値 最後の発話の信頼度スコア。

assistant_interaction_summaries.turns[].response

assistant_interaction_summaries.turns[].response オブジェクトには、以下のプロパティが含まれています。

プロパティー (Property) タイプ 説明
type ストリング

応答タイプ:

  • text_to_speech :発話を発信者に再生するコマンド
  • sms :SMSメッセージを発信者に送信するコマンド
  • url :オーディオファイルを発信者に再生するコマンド
  • transfer :通話を転送するコマンド
  • text_to_speech_config Text to Speechを変更するコマンド
  • speech_to_text_config Speech to Textを変更するコマンド
  • pause_speech_to_text :音声認識を停止するコマンド
  • unpause_speech_to_text : 音声認識を開始するコマンド
  • pause_dtmf : 着信DTMF信号の処理を停止するコマンド
  • unpause_dtmf : unpause_dtmf: 着信DTMF信号の処理を開始するコマンド
  • enable_speech_barge_in : 音声割り込みを有効にして、通話者が音声で再生を中断できるようにするコマンド
  • disable_speech_barge_in : 音声割り込みを無効にして、オーディオ再生中に通話者が話しても再生が中断されないようにするコマンド
  • enable_dtmf_barge_in :発信者が電話統合からの再生をキーを押すことで中断できるように、DTMF割り込みを有効にするコマンド
  • disable_dtmf_barge_in :発信者がキーを押しても電話統合からの再生が中断されないように、DTMF割り込みを無効にするコマンド
  • dtmf :発信者にDTMF信号を送信するコマンド
  • hangup :通話を切断するコマンド
    CDRと watsonx Assistant レスポンスタイプの間の対応を参照してください
barge_in_occurred ブール値 ターン中にバージインが発生したかどうか。
streaming_statistics オブジェクト Text to Speech 合成と再生に関する情報および統計。 assistant_interaction_summaries.turns[].response.streaming_statistics を参照してください。
CDR 応答タイプと watsonx Assistant 応答タイプの間のマッピング

type プロパティの値は、 watsonx Assistant レスポンスタイプに対応します。

CDR 応答タイプ watsonx Assistant 応答タイプ
text_to_speech text
url audio
dtmf dtmf, command_info.type : send
sms user_defined, vgwAction.command : vgwActSendSMS
transfer connect_to_agent
text_to_speech_config text_to_speech, command_info.type : configure
speech_to_text_config speech_to_text, command_info.type : configure
unpause_speech_to_text start_activities, type:speech_to_text_recognition
pause_speech_to_text stop_activities, type:speech_to_text_recognition
unpause_dtmf start_activities, type:dtmf_collection
pause_dtmf stop_activities, type:dtmf_collection
enable_speech_barge_in text_to_speech, command_info.type : enable_barge_in
disable_speech_barge_in text_to_speech, command_info.type : disable_barge_in
enable_dtmf_barge_in dtmf, command_info.type : enable_barge_in
disable_dtmf_barge_in dtmf, command_info.type : disable_barge_in
hangup end_session
assistant_interaction_summaries.turns[].response.streaming_statistics

assistant_interaction_summaries.turns[].response.streaming_statistics オブジェクトには、以下のプロパティが含まれています。

プロパティー (Property) タイプ 説明
transaction_id ストリング トランザクションの固有の識別子。
start_timestamp ストリング トランザクションが開始された時刻をISO形式( yyyy-MM-ddTHH:mm:ss.SSSZ )で指定します。
stop_timestamp ストリング 取引が終了した時刻をISO形式で入力してください( yyyy-MM-ddTHH:mm:ss.SSSZ )。
response_milliseconds 数値 テキスト音声がアシスタントに送信されてから、電話統合が合成音声の最初のパケットを受信するまでの時間(ミリ秒単位)。

warnings_and_errors

warnings_and_errors オブジェクトには、コール中に記録された警告とエラーが含まれており、それらは発生順にリスト化されています。 以下の条件に対する警告が含まれています。

  • 発話が信頼性スコアしきい値によってフィルターで除外されたときのメッセージ。
  • Text to Speech アンダーフロー。これは、Text to Speech 合成が電話統合のストリーミング速度に追いつかず、音声がスキップされる可能性がある場合です。
  • RTP ネットワーク警告 (高パケット・ロスや高平均ジッターなど) (RTCP が有効になっている場合)。

以下の例は、 warnings_and_errors オブジェクトの構造を示しています。

  "warnings_and_errors": [
    {
      "message": "CWSMR0032W: A Watson Speech to Text final utterance has a confidence score of 0.1, which does not meet the confidence score threshold of 0.2. The utterance will be ignored.",
      "id": "CWSMR0032W"
    },
    {
      "message": "CWSMR0031W: The synthesis stream from the Watson Text-to-Speech service can't keep up with the playback rate to the caller, so audio might skip. transaction ID=a1b2c3d4e5",
      "id": "CWSMR0031W"
    }
  ]

各警告の対象には、以下のプロパティが含まれています。

warnings_and_errors オブジェクトのプロパティー
プロパティー (Property) タイプ 説明
message ストリング 警告メッセージのテキスト。
id ストリング 固有のメッセージ ID。

max_response_milliseconds

max_response_milliseconds オブジェクトには、以下のプロパティが含まれています。

max_response_milliseconds オブジェクトのプロパティー
プロパティー (Property) タイプ 説明
assistant 数値 通話に関連するすべての watsonx Assistant リクエストから計算された、最大往復遅延(ミリ秒単位)。
text_to_speech 数値 テキスト発Text to Speechに送信されてから、電話統合が合成音声の最初のパケットを受信するまでの最大時間(ミリ秒単位)。 この値は、通話に関連するすべての Text to Speech 要求から計算されます。
speech_to_text 数値 発信者の音声から無音が検出されてから、 Speech to Textからの最終結果を受信するまでの最大遅延(ミリ秒単位)。 この値は、通話に関連するすべての Speech to Text 認識結果から計算されます。

realtime_transport_network_summary

RTCP が有効になっている場合、realtime_transport_network_summary オブジェクトは、inbound_stream オブジェクト内のインバウンド・ストリームの統計と、outbound_stream オブジェクト内のアウトバウンド・ストリームの統計を提供します。

次の例は、 realtime_transport_network_summary オブジェクトの構造を示しています。

"realtime_transport_network_summary": {
  "inbound_stream": {
    "maximum_jitter": 5,
    "average_jitter": 1,
    "packets_lost": 0,
    "packets_transmitted": 1000,
    "canonical_name": "user@example.com",
    "tool_name": "User SIP Phone"
   },
  "outbound_stream": {
    "maximum_jitter": 5,
    "average_jitter": 1,
    "packets_lost": 0,
    "packets_transmitted": 2000,
    "canonical_name": "voice.gateway@127.0.0.1",
    "tool_name": "IBM Voice Gateway/1.0.0.5"
   }
}

各ストリームのオブジェクトには、以下のプロパティが含まれています。

realtime_transport_network_summary オブジェクトのプロパティー
プロパティー タイプ 説明
maximum_jitter 数値 通話中の最大ジッター。
average_jitter 数値 通話時間中の平均ジッターを計算。
packets_lost 数値 通話中に失われたパケットの数の見積もり。
packets_transmitted 数値 通話中に送信されたパケットの総数のおおよその見積もり。
canonical_name ストリング ストリームの送信者を識別する一意のID。通常は @ 形式。
tool_name ストリング ストリームの元となったアプリケーションまたはツールの名称。 電話統合の場合、デフォルトは IBM Voice Gateway/ です。