通話セッションのメタデータ

このドキュメントでは、通話セッション メタデータ レコードのスキーマについて説明します。これは、CCAI Platform がすべての音声通話の終了時に出力する JSON ドキュメントです。CCAI Platform は、セッション終了コマンドの本文として CRM 統合にレコードを配信し、metadata.json ファイルとして外部ストレージ構成にレコードを書き込みます。各呼び出しで 1 つのレコードが生成されます。最上位の id は、各レコードを一意に識別します。このスキーマを使用して、レコードをダウンストリーム システムに取り込む、受信したペイロードを検証する、フィールドをデータ ウェアハウスの列にマッピングする、などの処理を行います。

スキーマのルート

通話セッション メタデータ レコードは、音声通話セッションを表す単一の JSON オブジェクトです。最上位の 3 つのコンセプトによって、レコードの ID と形状が決まります。

主キー - id(整数)

最上位の id は、インスタンス内の通話セッションを一意に識別します。通話ごとに 1 つのレコードが存在します。他のすべての最上位フィールド、配列、ネストされたオブジェクトは、この id が識別する呼び出しの属性を記述します。

ハンドラ識別子 - agent_info(オブジェクト、oneOf)

呼び出しの最後のハンドラに応じて形状が異なる単一のオブジェクト。2 つのバリアントは相互に排他的であり、キーがまったく存在しない場合もあります。そのため、レコードには 3 つのケースのうち最大 1 つが含まれます。

  • 人間のエージェントのバリアント - 通話に人間のエージェントがいて、仮想エージェントがいない場合に表示されます。共有の id、name、avatar_url フィールドに加えて、email、first_name、last_name、agent_number を保持します。

  • 仮想エージェント バリアント - 通話に仮想エージェントがあり、人間のエージェントがいない場合に表示されます。va_alias を保持し、email、first_name、last_name、agent_number を省略します。

  • キーが存在しない - agent_info キーは、通話に人間のエージェントも仮想エージェントも存在しない場合と、両方が存在する場合の 2 つのケースで省略されます。仮想エージェントが人間のエージェントへのエスカレーションをまたいで保持される場合、通話には両方が含まれます。そのため、完全に処理された通話がキーなしで到着することがあります。

レコードに含まれるバリアントを検出するには、まず agent_info キーが存在するかどうかを確認し、次にバリアント固有のフィールド(通常は人間のエージェント バリアントの場合は agent_info.email、仮想エージェント バリアントの場合は agent_info.va_alias)を確認します。agent_info のみからハンドラを推測しないでください。両方を含む通話の場合は、participants[] から人間のエージェントを読み取り、virtual_agent_handle_durations[] から仮想エージェントを読み取るか、transfers[] と escalations[] の from_virtual_agent フィールドと to_virtual_agent フィールドから仮想エージェントを読み取ります。各バリアントの完全な形状については、agent と virtual_agent をご覧ください。

呼び出し形状の識別子 - call_type、session_type、session_type_v2(文字列)

同じ基盤となるコールタイプの 3 つの並列ビュー。レコードが表す呼び出しタイプについて、両者が一致しないことはありません。異なるのは、呼び出しタイプの命名に使用する語彙だけです。

  • call_type は、以前の列挙型語彙(Voice Inbound (App)、Voice Outbound、Voice Internal など)を使用します。

  • session_type は常に call_type と同じ文字列を返します。CCAI プラットフォームは、このフィールドをキーとするインテグレーションとの下位互換性を確保するために、このフィールドを提供しています。call_type の非推奨のエイリアスとして扱ってください。バージョニングと非推奨をご覧ください。

  • session_type_v2 は、現在の列挙型語彙を使用します。この語彙は、call_type 語彙を拡張し、よりきめ細かいインバウンドの区別(たとえば、より広範な Voice Inbound (App) と Voice Inbound (IVR via App) の代わりに Voice Inbound (Mobile) と Voice Inbound (IVR via Mobile))を可能にします。v2 固有の値を持たない呼び出しタイプの場合、session_type_v2 は call_type と同じ文字列を返します。新しい統合では、session_type_v2 を解析する必要があります。

各フィールドの値については、コア情報をご覧ください。

主要情報

これらのプロパティは、通話のコア情報をキャプチャします。

  • id(整数): 各通話セッションの固有識別子。これは、呼び出しを区別する主キーです。

  • call_uuid(文字列または null): 動的コール ルーティング(DCR)インタラクションで、発信元インスタンスと受信インスタンス間の通話を関連付ける固有識別子。DCR 呼び出しの両方のレグは同じ call_uuid 値を共有するため、お客様は環境間でデータをブリッジできます。DCR インタラクションではない呼び出しと、CCAI Platform がフィールドを追加する前に発生した呼び出しの場合、このフィールドは null または空です。

  • lang(文字列): 通話の ISO 639 言語コード(例: 英語の場合は「en」、スペイン語の場合は「es」)。このコードは、言語固有の分析とレポート作成に役立ちます。

  • call_type(文字列): 以前のタイプの語彙を使用した呼び出しのタイプ。値には、「Voice Inbound (App)」、「Voice Inbound (Web)」、「Voice Inbound (IVR)」、「Voice Inbound (IVR via App)」、「Voice Inbound (API)」、「Voice Inbound (Direct)」、「Voice Inbound (Extension)」、「Voice Scheduled (App)」、「Voice Scheduled (Web)」、「Voice Scheduled (API)」、「Voice Callback」、「Voice Callback (Web)」、「Voice Outbound」、「Voice Outbound (API)」、「Voice Outbound (Direct)」、「Voice Outbound (UCaaS)」、「Voice Internal」、「Voice Campaign (Acqueon)」、「Voice Campaign (<your brand name>)」、「Agent Scheduled Call」があります。

  • session_type(文字列): CCAI Platform が下位互換性のために保持する call_type の複製(同じ値)。バージョニングとサポートの終了: 以前の重複をご覧ください。

  • session_type_v2(文字列): 現在のタイプの語彙を使用した呼び出しのタイプ。call_type 値をよりきめ細かいインバウンドの区別で調整します(たとえば、「Voice Inbound (App)」と「Voice Inbound (IVR via App)」の代わりに「Voice Inbound (Mobile)」と「Voice Inbound (IVR via Mobile)」を使用します)。値には、「Voice Inbound (Mobile)」、「Voice Inbound (Web)」、「Voice Inbound (IVR)」、「Voice Inbound (IVR via Mobile)」、「Voice Inbound (API)」、「Voice Inbound (Direct)」、「Voice Inbound (Extension)」、「Voice Scheduled (Mobile)」、「Voice Scheduled (Web)」、「Voice Scheduled (API)」、「Voice Callback」、「Voice Callback (Web)」、「Voice Outbound」、「Voice Outbound (API)」、「Voice Outbound (Direct)」、「Voice Outbound (UCaaS)」、「Voice Internal」、「Voice Campaign (Acqueon)」、「Voice Campaign (<ブランド名>)」、「Agent Scheduled Call」があります。

  • status(文字列): コールのステータス。コール ライフサイクル全体の進行状況を追跡します。有効な値(ライフサイクル フェーズ別にグループ化):

    • 接続前: "scheduled"、"selecting"、"queued"、"assigned"、"connecting"、"switching"、"requeued"、"requeued_detection_missed"。

    • 接続済み: "connected"。

    • 仮想エージェント: "va_assigned"、"va_connected"。

    • キャンペーン: "preview_pending"、"preview_ready"、"preview_waiting"、"predictive_waiting"、"progressive_waiting"、"campaign_dialing"、"campaign_connecting"、"campaign_connected"。

    • アクションのみ: "action_only"、"action_only_finished"。

    • ボイスメール: "voicemail"、"voicemail_received"、"voicemail_read"、"voicemail_forwarded"

    • ターミナル: "finished"、"failed"、"recovered"、"deflected"。

  • created_at(文字列、日時): CCAI Platform が通話レコードを作成した正確なタイムスタンプ。

  • queued_at(文字列、日時、または null): 通話がキューに入ったときのタイムスタンプ。通話がキューに入らなかった場合は null。

  • assigned_at(文字列、日時、または null): CCAI Platform がエージェントに通話を割り当てたときのタイムスタンプ。CCAI Platform が通話を割り当てなかった場合は null。

  • connected_at(文字列、日時、または null): 通話が接続されたときのタイムスタンプ。

  • ends_at(文字列、日時、または null): 通話が終了したときのタイムスタンプ。

  • scheduled_at(文字列、日時、または null): CCAI Platform が通話をスケジュールしたときのタイムスタンプ。通話が即時だった場合は null。

  • updated_at(文字列、日時): CCAI Platform が通話データを最後に更新したときのタイムスタンプ。

  • wait_duration(整数または null): 通話全体で消費者がキューで費やした合計時間(秒単位)。CCAI Platform がキュー時間を記録しなかった場合は null。個々のセグメントに分割されたキュー時間については、queue_durations 配列(キューの期間)をご覧ください。バージョニングと非推奨: 待機時間フィールドの命名規則をご覧ください。

  • call_duration(整数または null): 通話の合計時間(秒単位)。

  • hold_duration(整数または null): 消費者が保留にされた合計時間(秒単位)。保留時間がなかった場合は null。

  • rating(整数または null): ユーザーが送信した顧客満足度(CSAT)評価。ユーザーが評価を送信しなかった場合は null。

  • has_feedback(ブール値): ユーザーが通話後にフィードバックを提供したかどうかを示すフラグ。

  • voip_provider(文字列): 通話の VoIP プロバイダ。(注: このフィールドは非推奨であり、常に「deprecated」を返します)。

  • out_ticket_id(文字列または null): CCAI Platform が外部 CRM システムに作成したチケットの ID。

  • out_ticket_url(文字列、URI、または null): CRM チケットの URL。

  • is_out_ticket_account(ブール値または null): CRM チケットが顧客(true)または通話インタラクション(false)を表すかどうかを示します。

  • verified(ブール値): 検証スマート アクションがインタラクションを検証したかどうかを示します。

  • recording_url(文字列、URI、または null): 通話録音の URL。録音がない場合は null。

  • recording_permission(文字列または null): コンシューマーの録画権限のステータス。有効な値: 「not_asked」、「granted」、「denied」。

  • voicemail_reason(文字列): ボイスメールが残された理由。通話がボイスメールに転送されなかった場合は "not_voicemail"。有効な値は "not_voicemail"、"temporary_redirection"、"after_hour_deflection"、"over_capacity_deflection"、"no_input"、"no_agent" です。

  • disconnected_by(文字列または null): どちらの当事者が通話を終了したかを示します。値は disconnected_by_unknown、disconnected_by_agent、disconnected_by_end_user、disconnected_by_virtual_agent、disconnected_by_system のいずれかです。

  • fail_reason(文字列または null): 通話が失敗した理由。失敗しなかった通話の場合は "nothing"。指定可能な値は、障害の原因となったパーティまたはサブシステムごとにグループ化されます。

    • 失敗なし: nothing

    • 一般: unknown、expired、transfer_expired、canceled_outside_fulfillment_hours

    • エンドユーザー: eu_canceled、eu_rejected、eu_abandoned、eu_in_menu_abandoned、eu_repeated_voicemail、eu_repeated_callback、eu_dcr_abandoned_on_receiving、eu_busy、eu_wrong_number、eu_no_answer、eu_noti_failed、eu_phone_denied

    • エージェント: ag_canceled、ag_ignored、ag_declined、ag_mic_no_device、ag_mic_denied、ag_invalid_outbound_num、ag_called_blocked_num

    • 接続: conn_decline

    • VoIP: voip_twilio_error、voip_tokbox_error、voip_invalid_token、voip_conn_general、voip_conn_timeout、voip_conn_signal、voip_conn_codec、voip_nexmo_error、voip_telnyx_error

    • 音声: audio_not_received_by_carrier、audio_device_unable_to_start

    • スタック状態または解決不能な状態: stuck_due_to_api_error、group_deleted_no_substitute、menu_deleted、direct_pstn_call_to_fallback_number

    • キャンペーン: campaign_paused、campaign_queue_reassigned、campaign_no_incoming_contacts、campaign_call_canceled

    • 強制終了: force_ended、force_failed_call_stuck

  • fail_details(文字列または null): fail_reason に付随する、人が読める形式の追加の詳細(利用可能な場合)。

  • adapter_fail_code(整数または null): 呼び出しレベルの fail_reason に対応する数値コード。呼び出しが失敗しなかった場合は null。同じ列挙型が、§17 の参加者ごとの adapter_fail_code で使用されます。

  • adapter_fail_message(文字列または null): adapter_fail_code に対応する人が読める形式のメッセージ。呼び出しが失敗しなかった場合は null。

  • support_number(文字列または null): コンシューマがコンタクト センターにダイヤルした電話番号(E.164 形式)。IVR 発信の通話の場合に入力されます。他のチャネルの場合は null になることがあります。

  • queue_priority_level(整数。アカウントでキューの優先度が有効になっている場合にのみ存在): コールに割り当てられたキューの優先度。

エージェントと仮想エージェントの情報

以下のセクションでは、誰が、または何が通話に対応したかについて説明します。

  • agent_info(オブジェクト): このフィールドには、人間のエージェントまたは仮想エージェントに関する情報を保持できます。oneOf キーワードを使用して、2 つの型のいずれかであることを指定します。

    • agent(オブジェクト): 人間のエージェントに関する情報。

      • id(整数): エージェントの一意の ID。

      • agent_number(文字列または null): エージェントに割り当てられた識別子。

      • email(文字列、メール): エージェントのメールアドレス。

      • name(文字列): エージェントのフルネーム。

      • last_name(文字列): エージェントの姓。

      • first_name(文字列): エージェントの名前。

      • avatar_url(文字列、URI): エージェントのアバター画像の URL。

    • virtual_agent(オブジェクト): 仮想エージェントに関する情報。

      • id(整数): 仮想エージェントの一意の ID。

      • name(文字列): 仮想エージェントの名前。

      • avatar_url(文字列、URI、または null): 仮想エージェントのアバター画像。

      • va_alias(文字列または null): 仮想エージェントの表示エイリアス(設定している場合)。常にペイロードに存在します。エイリアスが設定されていない場合は null です。

  • selected_menu(オブジェクトまたは null): 通話中に消費者が選択したメニューに関する情報。

    • id(整数): メニューの一意の ID。

    • name(文字列): メニューの名前。

    • parent_id(整数または null): 親メニューの ID(存在する場合)。

    • position(整数): 同じレベルの他のメニューに対する相対的なメニュー位置。

    • deleted(ブール値): メニューが削除されたかどうか。

    • menu_type(文字列): メニューのタイプ(ivr_menu、sms_menu など)。

    • hidden(ブール値): メニューが表示され、使用可能かどうか。

  • menu_path(オブジェクトまたは null): ユーザーが移動したメニューの階層パスを記述します。

    • items_count(整数): パス内のメニューの数。

    • name(文字列): スラッシュで区切られたメニュー名の文字列(例: 「Support/Billing」)。

    • materialized_path(文字列): メニュー ID のスラッシュ区切りの文字列。

  • automation_redirection(オブジェクト。通話の最初の転送ログがリダイレクト グループに関連付けられている場合にのみ存在): この通話のルーティングに影響した、割合ベースのキュー リダイレクトの詳細。

    • percent_redirection(ブール値): ソースメニューで割合ベースのリダイレクトを有効にしたかどうか。

    • redirection_group(配列): リダイレクト グループの詳細を含む 1 要素の配列。

      • group_label(文字列): リダイレクト グループの人が読めるラベル(「リダイレクト グループ 1」など)。

      • destination(オブジェクトまたは null): グループに構成したリダイレクト先。

      • after_hours(ブール値または null): グループで営業時間外の転送オプションを有効にしたかどうか。

      • ah_destination(オブジェクトまたは null): グループに構成した営業時間外の転送先。

エンドユーザーの詳細

  • end_user(オブジェクトまたは null): ユーザーに関する情報。

    • id(整数または null): コンシューマーの内部 ID。

    • identifier(文字列または null): コンシューマーの外部識別子。

    • out_contact_id(文字列または null): CRM での消費者の ID。

カスタムデータと SDK 提供のデータ

  • customer_flag(オブジェクト。ウェブサイトがカスタム認証データを渡した場合にのみ存在): セッションの開始時に消費者のアプリまたはウェブサイトが渡した認証関連のカスタムデータ属性。ペイロードには、認証パラメータとして指定したサブセットのみが含まれます。

  • api_dap_request(オブジェクト。データ パラメータを有効にしてメタデータに含めた場合にのみ存在): 呼び出しのデータ パラメータ値のスナップショット。キーと値の型は、データ パラメータの構成によって異なります。

  • form_responses(配列。ユーザーが少なくとも 1 つのフォームの回答を送信した場合にのみ存在): セッション中に通話中 SDK フォームが収集した回答。各エントリには次のものが含まれます。

    • id(文字列または整数): フォームの回答の識別子。

    • title(文字列): ユーザーに表示されるフォームのタイトル。

    • smart_action_id(整数または null): フォームをトリガーしたスマート アクションの識別子(存在する場合)。

    • questions(配列): 収集された質問と回答のペア。

添付ファイル

  • photos(配列): 通話中にお客様がアップロードした写真。

    • id(整数): 写真の固有識別子。

    • photo_type(文字列): 写真の種類またはソース(「photo」など)。

    • url(文字列、URI): 保存された写真の URL。

    • smart_action_type(文字列または null): 写真を生成したスマート アクション(存在する場合)。

    • transfer_id(整数または null): ユーザーが転送後にアップロードした写真の転送イベント ID。

  • videos(配列): 通話中に消費者がアップロードした動画。

    • id(整数): 動画の固有識別子。

    • url(文字列、URI): 保存された動画の URL。

    • smart_action_type(文字列または null): 動画を生成したスマート アクション(存在する場合)。

    • transfer_id(整数または null): ユーザーが転送後に動画をアップロードした場合の、動画の転送イベント ID。

コール デフレクション

  • deflection(文字列): 通話が転送されたかどうか、および転送方法を示します(例: "no_deflection"、"over_cap_phone"、"after_hours_voicemail")。

  • deflection_details(配列): 通話中の偏向の詳細なログを提供します。各エントリ内の deflection フィールドは、定義: deflection で定義された列挙型を使用します。各エントリには次のものが含まれます。

    • id(整数): 偏向ログレコードの固有識別子。

    • call_id(整数): コールの固有識別子。

    • transfer_id(整数または null): 該当する場合、デフレクションに関連付けられた転送の固有識別子。

    • deflection(文字列。使用可能な値については、定義: 偏向をご覧ください): 偏向のタイプ。

    • created_at(文字列、日時): 偏向が発生したときのタイムスタンプ。

    • from_menu_path(オブジェクトまたは null): 偏向が開始されたメニューパス。

    • to_menu_path(オブジェクトまたは null): CCAI Platform が通話を転送したメニューパス。

    • to_sip_uri(文字列。CCAI Platform が通話を SIP 宛先に転送した場合にのみ存在): CCAI Platform が通話を転送した SIP URI(該当する場合)。

    • to_sip_headers(オブジェクト。CCAI Platform が通話を SIP 宛先に転送した場合にのみ存在): CCAI Platform が通話を転送した SIP ヘッダー(該当する場合)。

転送

  • transfers(配列): 通話中の転送イベントごとに 1 つのエントリ。エージェント、仮想エージェント、メニュー間のウォーム転送と引き継ぎなしの転送の両方を記録します。

    • id(整数): 転送の固有識別子。

    • status(文字列): 転送の現在のステータス(転送中、接続済み、失敗など)。

    • fail_reason(文字列): 転送が失敗した理由。失敗しなかった場合は「nothing」。

    • created_at(文字列、日時): 転送が開始された日時。

    • assigned_at(文字列、日時、または null): CCAI Platform が転送を受信者に割り当てた日時。

    • connected_at(文字列、日時、または null): 転送が接続された日時。

    • updated_at(文字列、日時): CCAI Platform が転送レコードを最後に更新した日時。

    • call_duration(整数): 転送されたセグメントの通話時間(秒単位)。

    • wait_duration(整数): コンシューマが転送中に待機した時間(秒単位)。

    • deflection(文字列): 転送に関連付けられたデフレクション タイプ(存在する場合)。

    • answer_type_path(文字列または null): 転送された通話がどのように解決されたかを示すパス。

    • from_menu_path / to_menu_path(オブジェクトまたは null): 転送前後のメニューパス。定義の menu_path と同じ形式です。

    • from_agent / to_agent(オブジェクトまたは null): 転送の両側の人間のエージェント。定義の agent オブジェクトと同じ形式です。

    • from_virtual_agent / to_virtual_agent(オブジェクトまたは null): 転送の両側の仮想エージェント。定義の virtual_agent オブジェクトと同じ形式です。

    • from_queue_priority_level / to_queue_priority_level(整数または null): 転送前後のキューの優先度。アカウントでキューの優先度を有効にしている場合にのみ表示されます。

通話処理時間

  • handle_durations(配列): オブジェクトの配列。各オブジェクトは、エージェントが処理した通話のセグメントを表します。これにより、エージェントの対応時間の分析がサポートされます。

    • id(整数): 処理時間の固有識別子。

    • agent_id(整数): エージェントの ID。

    • acw_duration(整数): 通話後の作業時間。

    • bcw_duration(整数): 通話前の作業時間。

    • call_duration(整数): このセグメント中の通話時間。

    • menu_path_id(整数または null): メニューパスの ID。

    • menu_path(文字列): メニューパスの名前。

    • lang(文字列): 使用される言語。

    • barged(ブール値): スーパーバイザーが通話に割り込んだかどうか。

    • transfer(ブール値): 転送が発生したかどうか。

    • transfer_id(整数または null): 転送の ID。

    • transfer_cold(ブール値または null): 転送が引き継ぎなしだったかどうか。

    • started_at(文字列、日時): 開始タイムスタンプ。

    • ended_at(文字列、日時、または null): 終了タイムスタンプ。

    • scheduled_at(文字列、日時、または null): スケジュール設定されたタイムスタンプ。

    • hold_duration(整数または null): このセグメント中の保留時間。

    • assigned_connection_duration(整数): このフェーズでエージェントが接続している間に消費者が待機した時間。

    • session_breakthrough(オブジェクト。エージェントの対応不可ステータスを無視して通話が割り当てられた場合にのみ存在): エージェントの対応不可ステータスを無視して通話が割り当てられた場合の割り当ての詳細(該当する場合)。

キューの期間

  • queue_durations(配列): オブジェクトの配列。各オブジェクトは、消費者がキューにいた通話のセグメントを表します。これにより、待ち時間とサービスレベルの分析がサポートされます。

    • id(整数): キューの期間の固有識別子。

    • agent_id(整数): エージェントの ID。

    • ended_at(文字列、日時): 終了タイムスタンプ。

    • lang(文字列): 使用される言語。

    • menu_path_id(整数): メニューパスの ID。

    • menu_path(文字列): メニューパスの名前。

    • queue_duration(整数): キュー セグメントの期間。

    • started_at(文字列、日時): 開始タイムスタンプ。

    • transfer_cold(ブール値): コールが引き継ぎなしの転送されたかどうか。

    • transfer(ブール値): 転送が発生したかどうか。

    • transfer_id(整数または null): 転送の ID。

    • service_level_abandon_time_threshold(整数): サービスレベルの放棄の時間しきい値。

    • service_level_event(文字列): サービスレベル イベントのステータス(「excluded」、「in_sla」、「not_in_sla」)。

    • service_level_target_percent(整数): サービスレベルのコンプライアンスの目標割合。

    • service_level_target_time(整数): サービスレベルの遵守の目標時間。

仮想エージェントから人間へのエスカレーション

  • escalations(配列): 各エントリは、仮想エージェントから人間のエージェントへのエスカレーションを表します。

    • id(整数): エスカレーションの固有識別子。

    • status(文字列): エスカレーションの現在のステータス。有効な値は、escalating、"escalated"、"canceled"、"deflecting"、"deflected" です。

    • reason(文字列): セッションがエスカレーションされた理由。

    • created_at(文字列、日時): エスカレーションが開始された日時。

    • escalated_at(文字列、日時、または null): エスカレーションが完了した日時。

    • from_virtual_agent(オブジェクトまたは null): 通話をエスカレーションした仮想エージェント。定義の virtual_agent オブジェクトと同じ形状。

    • to_agent(オブジェクトまたは null): 通話がエスカレーションされた人間のエージェント。定義の agent オブジェクトと同じ形状。

    • from_menu_path / to_menu_path(オブジェクトまたは null): エスカレーション前後のメニューパス。

仮想エージェントが回避したエスカレーション

  • virtual_agent_deflected_escalations(配列): 仮想エージェントからの回避されたエスカレーションの詳細。

    • id(整数): 固有識別子。

    • deflection(文字列): 偏向されたエスカレーションに対して記録された偏向タイプ。これは、定義: 偏向で説明されているコールレベルの偏向フィールドよりも小さい語彙です。仮想エージェントのエスカレーションで記録できる結果のみをカバーします。有効な値は次のとおりです。

      • 容量超過: over_cap、over_cap_phone、over_cap_voicemail、over_cap_callback、over_cap_message、over_cap_queue、over_cap_sip、over_cap_extension、over_cap_phone_with_extension

      • 営業時間外: after_hours、after_hours_phone、after_hours_voicemail、after_hours_message、after_hours_message_only、after_hours_queue、after_hours_sip、after_hours_extension、after_hours_phone_with_extension

      • 一時的なリダイレクト: temp_redirection、temp_redirection_phone、temp_redirection_voicemail、temp_redirection_message、temp_redirection_queue、temp_redirection_sip、temp_redirection_extension、temp_redirection_phone_with_extension

      • IVR セッション前: ivr_presession_deflection

      • 仮想エージェントが開始: va_redirection_phone、va_redirection_sip、va_third_party_phone、va_third_party_sip

      サフィックスのない over_cap、after_hours、temp_redirection の値は、デフレクションの結果に到達する前に通話が終了したときに記録されます。

    • escalation_id(整数): エスカレーション イベントの識別子。

    • escalation_reason(文字列): エスカレーションの理由。

    • escalated_at(文字列、日時): エスカレーションのタイムスタンプ。

    • menu_path_id(整数): メニューパス ID。

    • menu_path(文字列): メニューパス。

    • lang(文字列): 言語。

    • virtual_agent(オブジェクト): 仮想エージェントの詳細。定義をご覧ください。

仮想エージェントの処理時間

  • virtual_agent_handle_durations(配列): 仮想エージェントが通話を処理した時間セグメント。

    • id(整数): 固有識別子。

    • virtual_agent(オブジェクト): 仮想エージェントの詳細。定義をご覧ください。

    • call_duration(整数): セグメントの長さ。

    • escalation_reason(文字列): エスカレーションの理由。

    • finish_reason(文字列): インタラクションが終了した理由。

    • sentiment(整数): 顧客の感情。

    • response_count(整数): 仮想エージェントのレスポンス数。

    • fallback_response_count(整数): フォールバック レスポンスの数。

    • initiated_by(文字列): 仮想エージェント セッションの開始方法。

    • menu_path_id(整数): メニューパス ID。

    • menu_path(文字列): メニューパス。

    • lang(文字列): 言語。

    • transfer(ブール値): 通話が転送されたかどうか。

    • transfer_id(整数または null): 転送イベント識別子。

    • started_at(文字列、日時): 開始タイムスタンプ。

    • ended_at(文字列、日時、または null): 終了タイムスタンプ。

お客様の対応時間

  • consumer_handle_durations(配列): ユーザーが通話していた時間。

    • id(整数): 固有識別子。

    • call_duration(整数): コンシューマー セグメントの長さ。

    • hold_duration(整数または null): お客様の保留時間。

    • started_at(文字列、日時): 開始タイムスタンプ。

    • ended_at(文字列、日時): 終了タイムスタンプ。

コンシューマー イベントの期間

  • consumer_event_durations(配列): 消費者通話イベント(CSAT や支払いなど)の詳細。

    • id(整数): 固有識別子。

    • duration(整数): イベントの継続時間。

    • type(文字列): イベントタイプ。

    • event(文字列): イベントの結果。

    • menu_path_id(整数): メニューパス ID。

    • menu_path(文字列): メニューパス。

    • lang(文字列): 言語。

    • started_at(文字列、日時): 開始タイムスタンプ。

    • ended_at(文字列、日時): 終了タイムスタンプ。

消費者のメニュー表示時間

  • consumer_in_menu_durations(配列): メニュー内での消費者の操作の継続時間。

    • id(整数): 固有識別子。

    • duration(整数): メニュー内の時間。

    • event(文字列): メニュー操作の結果。

    • menu_path_id(整数): メニューパス ID。

    • menu_path(文字列): メニューパス。

    • lang(文字列): 言語。

    • started_at(文字列、日時): 開始タイムスタンプ。

    • ended_at(文字列、日時): 終了タイムスタンプ。

参加者

  • participants(配列): 通話の各参加者(消費者、エージェント、仮想エージェントなど)に関する情報。

    • id(整数): 参加者の固有識別子。

    • type(文字列): 参加者のタイプ(「end_user」、「agent」、「virtual_agent」など)。

    • entry_type(文字列): 参加者が通話に参加した方法。

    • user_id(整数または null): 参加者がエージェントの場合のユーザー ID。

    • end_user_id(整数または null): 参加者がコンシューマーの場合のコンシューマー ID。

    • virtual_agent_id(整数または null): 参加者が仮想エージェントの場合の仮想エージェント ID。

    • virtual_agent_params(オブジェクト。仮想エージェントのカスタム メタデータを含めるように構成した場合にのみ存在): 仮想エージェントが使用するカスタム メタデータ。

    • status(文字列): 参加者のステータス(「waiting」、「connected」、「finished」など)。

    • fail_reason(文字列): 失敗の理由(該当する場合)。

    • connected_at(文字列、日時、または null): 参加者が接続したときのタイムスタンプ。

    • phone_number(文字列、一般ユーザーの参加者にのみ存在): 参加者の電話番号。

    • call_id(整数): 呼び出しの識別子。

    • call_duration(整数または null): 参加者の通話時間。

    • hold_duration(整数または null): 参加者の保留時間。

    • ended_at(文字列、日時、または null): 参加者の関与が終了したときのタイムスタンプ。

    • adapter_fail_code(整数または null): 失敗の理由に対応する数値コード。

    • adapter_fail_message(文字列または null): fail_reason の人が読める形式の説明(存在する場合)。

    • agent_assist(オブジェクト。Agent Assist を構成するときにエージェント参加者にのみ存在): この参加者のアクティブな Agent Assist 設定。

    • virtual_agent(オブジェクト、仮想エージェントの参加者にのみ存在): この参加者として機能する仮想エージェントの詳細。最上位の agent_info や virtual_agent_params とは異なります。

    • caller_id(文字列。アカウントで SIP ヘッダーの発信者番号を有効にしている場合、かつコンシューマー参加者のみに存在): CCAI Platform がこのコンシューマー参加者のインバウンド SIP ヘッダーから抽出する発信者番号。

    • sip_headers(オブジェクトまたは null): この参加者に関連付けられた SIP ヘッダー。常にペイロードに存在します。CCAI Platform がヘッダーをキャプチャしない場合は null です。

    • location(文字列または null、エージェント参加者にのみ存在): エージェントのロケーション。

    • location_id(整数または null、エージェント参加者にのみ存在): 地域 ID。

    • email(文字列、メール、エージェント参加者にのみ存在): エージェントのメールアドレス。

    • first_name(文字列または null。エージェント参加者にのみ存在): エージェントの名前。

    • last_name(文字列または null、エージェント参加者にのみ存在): エージェントの姓。

    • middle_name(文字列または null、エージェント参加者にのみ存在): エージェントのミドルネーム。

    • teams(配列、エージェント参加者にのみ存在): エージェントのチームの { id, name } オブジェクトの配列。

録画

  • recordings(配列): 通話録音に関する情報。

    • id(整数): 録音の固有識別子。

    • call_id(整数): 呼び出し ID。

    • conference_sid(文字列または null): VoIP プロバイダの通話 ID。

    • duration(整数または null): 録画時間。

    • recording_type(文字列): 録画のタイプ。

    • redaction_times(配列): 秘匿化された時間セグメント。

      • start(文字列、日時): 秘匿化間隔の開始日時。

      • end(文字列、日時): 秘匿化間隔が終了した日時。

      • duration(整数): 秘匿化の継続時間(秒単位)。

      • start_agent_id(整数または null): 削除を開始したエージェント。

      • end_agent_id(整数または null): 音声除去を終了したエージェント。

    • started_at(文字列、日時): 録画開始のタイムスタンプ。

  • post_processed_recordings(配列。アカウントで後処理録音を有効にしている場合にのみ存在): 後処理(形式変換や秘匿化など)によって生成される音声録音。

    • id(整数): 後処理された録音の固有識別子。

    • call_id(整数): 呼び出し ID。

    • duration(整数): 録画時間(秒単位)。

    • started_at(文字列、日時): 録画開始のタイムスタンプ。

    • recording_file_name(文字列): 後処理された音声アセットのファイル名。

    • recording_url(文字列、URI): 後処理された音声ファイルの URL。

    • agent_id(整数または文字列): セグメントに関連付けられたエージェントの ID。

    • virtual_agent_id(整数または文字列): セグメントに関連付けられている仮想エージェントの識別子(存在する場合)。

    • conversation_id(文字列): この録音を会話レコードに関連付ける識別子。

  • segments(配列。アカウントで後処理された分析情報の録画を有効にしている場合にのみ存在): システムがダウンストリーム分析情報パイプライン用に生成する、参加者ごとの音声(およびオプションの画面録画)セグメント。

    • id(整数): セグメントの固有識別子。

    • call_id(整数): 呼び出し ID。

    • duration(整数): セグメントの長さ(秒単位)。

    • started_at(文字列、日時): セグメント開始のタイムスタンプ。

    • audio_file_name(文字列): セグメントの音声アセットのファイル名。

    • audio_url(文字列、URI): セグメントの音声ファイルの URL。

    • agent_id(整数または文字列): セグメントに関連付けられたエージェントの ID。

    • virtual_agent_id(整数または文字列): セグメントに関連付けられている仮想エージェントの識別子(存在する場合)。

    • participant_id(整数または文字列): セグメントが属する参加者の識別子。

    • conversation_id(文字列): このセグメントを会話レコードに関連付ける識別子。

    • screen_recording_url(文字列、URI、または null): 一致する画面録画アセットの URL。アカウントで画面録画を有効にしている場合にのみ表示されます。

    • screen_recording_file_name(文字列または null): 画面録画のファイル名。screen_recording_url と同じ条件で存在します。

イベントを提供する

  • offer_type(文字列または null): CCAI Platform がエージェントに通話を提示した方法。

  • offer_events(配列): CCAI Platform がエージェントに通話を提案したときのイベント。

    • casting_time(文字列、日時): CCAI Platform が通話を提供した時刻。

    • group(文字列): CCAI Platform が通話を提供したグループ。

その他の情報

  • answer_type(文字列または null): 通話が解決された方法(「manual」または「auto」)。

  • outbound_number(文字列または null): 使用された発信電話番号。

  • wait_time_sms(配列。この通話で待機時間 SMS のやり取りが発生した場合にのみ存在): CCAI プラットフォームが予想待機時間について消費者に送信した SMS のやり取り。各エントリには次のものが含まれます。

    • transfer_id(整数または null): 転送イベント識別子(転送に関連付けられている場合)。

    • status(文字列): SMS のステータス。指定できる値: not_triggered、triggered、triggered_allowed、triggered_denied、triggered_no_selection、triggered_sent、triggered_failed。

    • received(ブール値): ユーザーが SMS を受信したかどうか。

  • in_call_sms(配列。この通話中に通話中の SMS インタラクションが発生した場合にのみ存在): 通話中の SMS インタラクション。各エントリには次のものが含まれます。

    • transfer_id(整数または null): 転送イベント識別子(転送に関連付けられている場合)。

    • preset_sent(ブール値): CCAI プラットフォームがプリセット メッセージを送信したかどうか。

    • custom_sent(ブール値): エージェントがカスタム(フリーテキスト)メッセージを送信したかどうか。

    • received(ブール値): CCAI プラットフォームがコンシューマーから SMS を受信したかどうか。

  • dispositions(配列。アカウントでまとめコードまたはメモを有効にしている場合にのみ存在): エージェントが記録したまとめコードとメモ。各エントリには、まとめ構成に基づいて動的にレンダリングされるフィールドが含まれます。

    • user_id(整数): エージェント ID。

    • transfer_id(整数または null): 転送後に記録された転送イベント識別子。

    • participant_id(整数): 参加者 ID。

    • note(文字列): エージェントのメモ(フリーテキスト)。

    • original_note(文字列): メモの元の(編集前の)バージョン。

    • code(文字列): 処理コード名。

    • ujet_code_id(整数または空の文字列): 処理コードの CCAI プラットフォーム ID。コードの安定したキー(コードの表示名は変更可能)。利用できない場合は空の文字列。

    • list(文字列): コードが属するリストの名前。

    • list_path(文字列): コードのリストのスラッシュ区切りのパス。

    • ujet_list_id(整数または空の文字列): 処理コードが属するリストの CCAI プラットフォーム ID。リストの安定したキー。使用できない場合は空の文字列。

    • custom_list_id(文字列または整数): マッピングされている場合、顧客定義のリスト識別子。

    • custom_code_id(文字列または整数): マッピングされている場合、お客様が定義したコード識別子。

  • email(文字列、メール、または null): ユーザーのメールアドレス。

  • feedback(文字列または null): ユーザーのフィードバック。

  • smart_action_text(文字列または null): 実行されたスマート アクションのテキスト。

  • custom_data_secured(オブジェクトまたは null): カスタムの安全に署名されたデータ。

  • custom_data_not_secured(オブジェクトまたは null): カスタムの、安全に署名されていないデータ。

  • in_queue_wait_time_va(配列。アカウントの仮想エージェントのキュー内待機時間トラッキングを有効にし、少なくとも 1 つの仮想エージェントのエスカレーションが発生した場合にのみ存在します): CCAI Platform がエスカレーション後に仮想エージェントを保持している間に、消費者がキューで待機した時間間隔。各エントリには次のものが含まれます。

    • start(文字列、日時): キューの待機が開始された日時。

    • end(文字列、日時、または null): キューの待機が終了した日時。完了していない場合は null。

    • duration(整数または null): 待機時間(秒)。end が null の場合は null。

  • auto_session_summaries(配列。アカウントで会話の要約を有効にし、CCAI Platform が要約を正常に生成した場合にのみ存在します): CCAI Platform が CRM レコードに保存する AI 生成のセッション要約。各エントリには次のものが含まれます。

    • user_id(整数): 要約に関連付けられているエージェント参加者の ID。

    • participant_id(整数): 参加者 ID。

    • session_summary(文字列): 概要テキスト。

    • session_summary_sections(配列またはオブジェクト): 構造化されたセクションの要約(利用可能な場合)。

  • sip_headers(オブジェクト。アカウントで SIP ヘッダー キャプチャを有効にし、セッション メタデータに含めるように構成した場合にのみ存在します): CCAI Platform が通話用にキャプチャしたインバウンド SIP ヘッダー。キーと値には、アップストリームのテレフォニー プロバイダから受信した SIP ヘッダーが反映されます。

定義

このセクションでは、各サブスキーマを 1 回定義します。サブスキーマを参照するプロパティ グループは、インラインで形状を再定義するのではなく、これらの定義にリンクします。

通話がたどった階層メニューパスを記述します。フィールドの全一覧については、メニュー ナビゲーションをご覧ください。

参照元: 最上位の menu_path フィールド、各 transfers[].from_menu_path と transfers[].to_menu_path、各 escalations[].from_menu_path と escalations[].to_menu_path、各 deflection_details[].from_menu_path と deflection_details[].to_menu_path。

agent(オブジェクト)

人間のエージェントについて説明します。このオブジェクトは、最上位の agent_info 識別子の 2 つのバリアントの 1 つです(スキーマのルートをご覧ください)。フィールドの完全なリストについては、エージェントと仮想エージェントの情報をご覧ください。

参照元: 人間のエージェントが最後に通話を処理したときの agent_info フィールド、各 transfers[].from_agent と transfers[].to_agent、各 escalations[].to_agent。

virtual_agent(オブジェクト)

仮想エージェントについて説明します。このオブジェクトは、最上位の agent_info 識別子の 2 つのバリアントの 1 つです(スキーマのルートを参照)。フィールドの完全なリストについては、エージェントと仮想エージェントの情報をご覧ください。

参照元: 仮想エージェントが最後に通話を処理したときの agent_info フィールド、各 transfers[].from_virtual_agent と transfers[].to_virtual_agent、各 escalations[].from_virtual_agent、各 virtual_agent_handle_durations[].virtual_agent、各 virtual_agent_deflected_escalations[].virtual_agent。

deflection(文字列、列挙型)

通話または通話セグメントのデフレクション状態。値は &lt;trigger&gt;_&lt;destination&gt; の命名パターンに従います。接頭辞は、デフレクションをトリガーした条件(容量超過、営業時間外、一時的なリダイレクトなど)を識別し、接尾辞は宛先または処理(ボイスメール、キュー、電話、メッセージなど)を識別します。

一般的な宛先サフィックス:

  • _phone - 通話を外部の電話番号に転送します。

  • _voicemail - 通話をボイスメールに転送します。

  • _message - 情報メッセージを再生します。

  • _message_only - メッセージを再生し、それ以上のルーティングを行わずに通話を終了します。

  • _callback - 予定されたコールバックを提案します。

  • _wait - 発信者を待機状態にします。

  • _queue - 通話を別のキューに転送します。

  • _sip - SIP 宛先に通話を転送します。

  • _extension - 通話を内線に転送します。

  • _phone_with_extension - 内線番号付きの電話の宛先に通話を転送します。

使用できる値(トリガー ファミリー別にグループ化):

  • デフレクションなし: no_deflection、deflecting。

  • 容量超過 - キューが容量しきい値を超えた場合: over_cap_phone、over_cap_voicemail、over_cap_callback、over_cap_wait、over_cap_queue、over_cap_message、over_cap_ewt_only、over_cap_sip、over_cap_extension、over_cap_phone_with_extension。

  • 放棄されたデフレクション - 保留中のデフレクションが解決される前に転送または通話が終了した場合: deflection_abandoned。

  • 営業時間外 - メニューに設定された営業時間外に着信した場合: after_hours_voicemail、after_hours_phone、after_hours_message_only、after_hours_queue、after_hours_message、after_hours_sip、after_hours_extension、after_hours_phone_with_extension。

  • 一時的なリダイレクト - メニューで一時的なリダイレクトを構成する場合: temp_redirection_phone、temp_redirection_message、temp_redirection_voicemail、temp_redirection_queue、temp_redirection_sip、temp_redirection_extension、temp_redirection_phone_with_extension。

  • IVR セッション前: ivr_presession_deflection。

  • 仮想エージェントが開始 - 仮想エージェントが通話をリダイレクトまたは引き継いだ場合: va_redirection_phone、va_redirection_sip、va_third_party_phone、va_third_party_sip。

  • 営業時間外の内部通話: internal_call_after_hours_message、internal_call_after_hours_queue、internal_call_after_hours_phone、internal_call_after_hours_extension、internal_call_after_hours_sip、internal_call_after_hours_voicemail。

  • 内部呼び出しの容量超過: internal_call_over_capacity_message、internal_call_over_capacity_queue、internal_call_over_capacity_phone、internal_call_over_capacity_extension、internal_call_over_capacity_sip、internal_call_over_capacity_voicemail、internal_call_over_capacity_wait。

  • 内部呼び出しの自動リダイレクト: internal_call_automatic_redirection_message、internal_call_automatic_redirection_queue、internal_call_automatic_redirection_phone、internal_call_automatic_redirection_extension、internal_call_automatic_redirection_sip、internal_call_automatic_redirection_voicemail。

  • 営業時間外の通話転送: call_transfer_after_hours_message、call_transfer_after_hours_queue、call_transfer_after_hours_phone、call_transfer_after_hours_extension、call_transfer_after_hours_sip、call_transfer_after_hours_voicemail。

  • 通話転送の容量超過: call_transfer_over_capacity_message、call_transfer_over_capacity_queue、call_transfer_over_capacity_phone、call_transfer_over_capacity_extension、call_transfer_over_capacity_sip、call_transfer_over_capacity_voicemail、call_transfer_over_capacity_wait。

  • 通話転送の自動リダイレクト: call_transfer_automatic_redirection_message、 call_transfer_automatic_redirection_queue、 call_transfer_automatic_redirection_phone、 call_transfer_automatic_redirection_extension、 call_transfer_automatic_redirection_sip、 call_transfer_automatic_redirection_voicemail。

  • 緊急シャットダウン - 管理者が緊急シャットダウンをトリガーした場合: emergency_shutdown、emergency_shutdown_message、emergency_shutdown_after_hours、emergency_shutdown_over_capacity。

  • 動的コール ルーティング(DCR): dcr_transferred、dcr_missed、dcr_redirected、dcr_finished。

参照元: この語彙を完全に使用する各 deflection_details[].deflection。他の 2 つのフィールドは、それぞれそのサブセットを利用します。

  • 最上位の deflection フィールドは、over_cap_ewt_only と temp_redirection_url 以外のすべての値を使用します。

  • 各 transfers[].deflection は、転送スコープの小さなサブセット(no_deflection、deflecting、deflection_abandoned、10 個の over_cap_* 値、8 個の after_hours_* 値、temp_redirection_url 以外の 7 個の temp_redirection_* 値、ivr_presession_deflection、va_redirection_phone、va_redirection_sip)を使用します。internal_call_*、call_transfer_*、emergency_shutdown_*、dcr_*、va_third_party_* ファミリーは転送に表示されません。

バージョニングと非推奨

通話セッション メタデータ スキーマは、下位互換性のある進化をサポートしています。CCAI Platform では、新しいフィールドと配列をいつでも追加できます。統合では、機能が継続されるように、認識されないキーを無視する必要があります。このセクションのフィールドは、非推奨、レガシー、またはソフト置換されています。下位互換性のためにペイロードに残っていますが、新しい統合では各フィールドのガイダンスに従う必要があります。

非推奨のフィールド

  • voip_provider(文字列)- 非推奨。常にリテラル文字列「deprecated」を返します。CCAI Platform は、このドキュメントを通じてインテグレーションにプロバイダ情報を表示しなくなりました。代替フィールドはありません。統合でアップストリームの電話プロバイダを識別する必要がある場合は、アカウント チームにお問い合わせください。

以前の重複

  • session_type(文字列)- call_type のレガシー エイリアス。常に call_type と同じ値を返し、同じ以前の列挙型語彙を使用します。CCAI プラットフォームでは、session_type をキーとするインテグレーションとの下位互換性を維持するために、このフィールドが保持されます。新しい統合では、call_type を直接解析するか、よりきめ細かいインバウンドの区別を行うために session_type_v2 を解析する必要があります(下記の語彙の進化を参照)。

語彙の進化

call_type と session_type_v2 は、2 つの異なる語彙を使用して同じ基盤となる呼び出しタイプを記述します。CCAI プラットフォームは、すべてのレコードで両方のフィールドを出力します。これらは互いに重複していません。

  • call_type は、以前の列挙型語彙を使用しています。Voice Inbound (App) や Voice Inbound (IVR via App) などの値は、すべてのインバウンド モバイル SDK とアプリ内 SDK の送信元を 1 つのラベルでカバーします。call_type は非推奨ではありません。CCAI Platform は引き続きこのフィールドを出力しますが、その語彙に新しいきめ細かい値は追加されません。

  • session_type_v2 は、現在の列挙型語彙を使用します。v2 固有の値を持つ通話タイプに対して、よりきめ細かいインバウンドの区別(Voice Inbound (Mobile) や Voice Inbound (IVR via Mobile) など)が導入されています。v2 固有の値がない呼び出しタイプの場合、session_type_v2 は call_type と同じ文字列を返します。

新しい統合では session_type_v2 を解析する必要があります。各フィールドの値は、コア情報に記載されています。

待ち時間フィールドの命名規則

通話セッション メタデータ ドキュメントでは、2 つのフィールド名で 2 つのスコープのキュー待機時間が報告されます。

  • 通話の合計 - 最上位の wait_duration フィールドには、通話全体でコンシューマがキューに費やした合計時間が格納されます。

  • セグメントごと - 最上位の queue_durations 配列(キューの期間)の各エントリには、独自の queue_duration フィールドがあり、その個々のキュー セグメントのキュー時間が保持されます。

どちらの名前も、異なるスコープで同じ種類の測定(キューで費やされた時間)を指します。call-total wait_duration は、コンシューマのキュー全体の時間を反映し、セグメントごとの queue_duration 値は各キュー セグメントを表します。このドキュメントでは、個別の最上位 queue_duration フィールドは出力されません。セグメントごとの値は queue_durations 内でのみ使用できます。