チャット セッションのメタデータ

このドキュメントでは、チャット セッション メタデータ レコードのスキーマについて説明します。メタデータ レコードは、コンタクト センター AI プラットフォームがサポート チャット セッション用に作成する JSON ドキュメントです。CCAI Platform は、チャットの session-end コマンドの一部として、メタデータ レコードを CRM 統合に配信します。外部ストレージを有効にすると、CCAI Platform は metadata.json ファイルを使用して外部ストレージ構成にレコードを書き込みます。各チャットは 1 つのレコードを生成し、最上位の id によって一意に識別されます。このスキーマを使用して、レコードをダウンストリーム システムに取り込む、受信したペイロードを検証する、フィールドをデータ ウェアハウスの列にマッピングする、などの処理を行います。

スキーマのルート

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

主キー: id(整数)

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

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

チャットの最後のハンドラに応じて形状が異なる単一のオブジェクト。2 つのバリアントは相互に排他的です。

  • 人間のエージェントのバリアント: チャットの最後のハンドラが人間のエージェントだった場合に表示されます。共有の id、name、avatar_url フィールドに加えて、email、first_name、last_name、agent_number を保持します。

  • 仮想エージェント バリアント: チャットの最後のハンドラが仮想エージェントだった場合に表示されます。va_alias を保持し、email、first_name、last_name、agent_number を省略します。

レコードにどのバリアントが含まれているかを検出するには、バリアント固有のフィールド(通常は人間のエージェント バリアントの場合は agent_info.email、仮想エージェント バリアントの場合は agent_info.va_alias)の有無を確認します。各バリアントの完全な定義は、定義: agent と定義: virtual_agent に記載されています。

チャット形状の識別子: chat_type、session_type、session_type_v2(文字列)

同じ基盤となるチャットタイプの 3 つの並列ビュー。レコードが表すチャットタイプについて、これらが一致しないことはありません。異なるのは、名前を付けるために使用される語彙のみです。

  • chat_type: 以前の列挙型語彙(Messaging Inbound(App Chat)、Messaging(SMS)、Messaging(WhatsApp)など)を使用します。

  • session_type: 常に chat_type と同じ文字列を返します。このフィールドをキーとする統合との下位互換性のために存在します。chat_type の非推奨のエイリアスとして扱ってください。

  • session_type_v2: 現在の列挙型語彙を使用します。これには、メッセージング インバウンド(モバイルチャット)などのより細かい区別が含まれる場合があります。v2 固有の値がないチャットタイプの場合、session_type_v2 は chat_type と同じ文字列を返します。新しい統合では session_type_v2 を解析する必要があります。

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

主要情報

  • id(整数): 各チャット セッションの固有識別子。この主キーは、チャットを区別します。

  • lang(文字列): チャットで使用された ISO 639 言語コード(例: 英語の場合は "en"、スペイン語の場合は "es")。

  • chat_type(文字列): チャットのタイプ。以前のタイプの語彙を使用します。値は "Messaging Inbound (App Chat)"、"Messaging Inbound (Web Chat)"、"Messaging (SMS)"、"Messaging (WhatsApp)"、"Messaging (Apple Messaging for Business)" です。

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

  • session_type_v2(文字列): チャットのタイプ。現在のタイプの語彙を使用します。chat_type 値をより細かく区別して調整します。値は "Messaging Inbound (Mobile Chat)"、"Messaging Inbound (Web Chat)"、"Messaging (WhatsApp)"、"Messaging (Apple Messaging for Business)"、"Messaging (SMS)"、"Messaging Inbound (SMS)"、"Messaging Outbound (SMS)"、"Messaging Outbound (SMS via API)"、"Messaging Inbound (SMS Direct)"、"Messaging Outbound (SMS Direct)"、"Messaging Outbound (SMS Direct via API)" です。

  • status(文字列): チャットの現在のステータス。値は "queued"、"selecting"、"assigned"、"va_assigned"、"dismissed"、"va_dismissed"、"check_in_timeout"、"finished"、"no_response"、"canceled"、"failed" のいずれかです。(CCAI プラットフォームは、ユーザーからの返信がない終了したチャットを "no_response" として報告します)。

  • sub_status(文字列または null): チャットのより具体的なステータスの詳細(利用可能な場合)。指定できる値: "selecting"、"queued"、"ongoing"、"dismissed"、"finished"、"timeout"、"deflected"、"abandoned"、"expired"、"failed"、"disconnected_by_agent"、"disconnected_by_end_user"、"no_messages"、"no_messages_disconnected_by_agent"、"no_messages_disconnected_by_end_user"、"end_user_opt_out"。

  • created_at(文字列、日時): CCAI Platform がチャット セッションを作成したときのタイムスタンプ。

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

  • ends_at(文字列、日時、または null): チャット セッションが終了したときのタイムスタンプ。

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

  • first_msg_sent_at(文字列、日時、または null): 参加者がチャットで最初のメッセージを送信したときのタイムスタンプ。

  • last_msg_sent_at(文字列、日時、または null): 参加者がチャットで最後のメッセージを送信したときのタイムスタンプ。

  • wait_duration(整数): コンシューマが待機した合計時間(秒)。

  • chat_duration(整数): チャットの合計時間(秒単位)。

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

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

  • has_feedback(ブール値): チャット後に消費者がフィードバックを提供したかどうかを示します。

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

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

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

  • fail_reason(文字列): チャット中にエラーが発生した理由。チャットが失敗しなかった場合は "nothing"。指定できる値: "nothing"、"unknown"、"expired"、"after_hours"、"escalation_failed"、"check_in_timed_out"、"check_in_timed_out_expired"、"expired_menu_selection"、"end_user_opt_out"、"over_cap_email"、"group_deleted_no_substitute"、"presession_deflection_unknown"、"presession_deflection_timeout"、"presession_deflection_message_delivery_failed"、"sms_error"、"force_ended"。

  • provider_type(文字列): 使用されるチャット プロバイダのタイプ。有効な値は、"unknown"、"messaging"、"twilio_conversations"、"nexmo_conversations"、"ujet_conversations" です。

  • provider_channel_id(文字列または null): チャットのプロバイダ固有のチャネル識別子。

  • message_count(整数): チャットで交換されたメッセージの合計数。

  • average_response_time(整数): チャット中にエージェントが応答するのにかかった平均時間(秒単位)。

  • longest_response_time(整数): チャット中にエージェントが応答するまでに要した最長時間(秒)。

  • transcript(ブール値): セッションのチャットの文字起こしが存在するかどうかを示します。

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

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

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

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

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

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

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

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

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

      • avatar_url(文字列、URI、または null): エージェントのアバター画像の 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(整数または null): 同じレベルの他のメニューに対する相対的なメニュー位置。

    • deleted(ブール値): 管理者がメニューを削除したかどうかを示します。

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

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

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

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

    • name(文字列または null): メニュー名のスラッシュ区切りの文字列(例: "Support/Billing")。メニューパスが使用できない場合は null。

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

  • queue_priority_level(整数): チャットの選択されたキューに割り当てられたキューの優先度。アカウントでキューの優先度が有効になっている場合にのみ表示されます。

エンドユーザーの詳細

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

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

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

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

顧客フラグと SDK 提供データ

  • customer_flag(オブジェクト): セッション中に外部システムが提供または更新した、注目すべきコンシューマー属性をマークするフラグ。セッション中に外部システムが認証関連のお客様フラグを提供または更新した場合にのみ存在します。

    • verified_customer(ブール値): 外部システムがコンシューマを検証済みとしてフラグを立てたかどうかを示します。

    • bad_actor(ブール値): 外部システムがコンシューマーを不正なアクターとしてフラグ付けしたかどうかを示します。

    • repeat_customer(ブール値): 外部システムが消費者をリピーターとしてフラグ付けしたかどうかを示します。

  • custom_data_secured(オブジェクトまたは null): SDK または Apps API が提供する、安全に署名されたカスタムデータ。

  • custom_data_not_secured(オブジェクトまたは null): SDK または Apps API が提供する、安全に署名されていないカスタムデータ。

  • sip_headers(オブジェクト): チャットでキャプチャされたインバウンド SIP ヘッダー。キーと値は、上流のプロバイダから受信した SIP ヘッダーを反映します。アカウントで SIP ヘッダー キャプチャを有効にし、セッション メタデータに表示されるように構成した場合にのみ表示されます。

添付メディア ファイル

  • photos(配列): チャットに関連付けられた写真またはスクリーンショット。

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

    • photo_type(文字列): 写真のタイプ。可能な値は "photo" と "screenshot" です。

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

    • smart_action_type(文字列または null): 写真に関連付けられたスマート アクション(存在する場合)。

    • transfer_id(整数または null): 参加者が転送完了後に写真をアップロードした場合、写真に関連付けられた転送イベント識別子。

  • videos(配列): チャットに関連付けられた動画。

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

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

    • smart_action_type(文字列または null): 動画に関連付けられたスマート アクション(存在する場合)。

    • transfer_id(整数または null): 参加者が転送完了後に動画をアップロードした場合、その動画に関連付けられた転送イベント識別子。

チャットの転送

  • transfers(配列): チャット中の転送イベントごとに 1 つのエントリ。エージェント、仮想エージェント、メニュー間の転送を記録します。

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

    • status(文字列): 転送の現在のステータス。可能な値は、"transferring"、"transferred"、"failed"、"deflected" などです。

    • fail_reason(文字列): 転送が失敗した理由。失敗しなかった場合は "nothing"。指定できる値: "nothing"、"timeout"、"canceled"、"ag_connection_timeout"、"va_failure"、"agent_detection_missed"、"unknown"、"unreachable_phone_number"。

    • created_at(文字列、日時): 転送が開始されたときのタイムスタンプ。

    • assigned_at(文字列、日時、または null): CCAI Platform が転送を割り当てたときのタイムスタンプ。

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

    • updated_at(文字列、日時、または null): CCAI Platform が転送レコードを最後に更新したときのタイムスタンプ。

    • call_duration(整数または null): 転送されたチャット セグメントの継続時間(秒単位)。

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

    • deflection(文字列): 転送に関連付けられた偏向タイプ。使用できる値については、定義: 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(整数または null): エージェントの識別子。

    • acw_duration(整数): チャット後の作業時間(秒単位)。

    • chat_duration(整数): このセグメント中のチャットの継続時間(秒単位)。

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

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

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

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

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

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

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

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

    • response_time_total(整数): エージェントの合計応答時間(秒)。

    • response_time_max(整数): エージェントの最長応答時間(秒)。

    • response_time_avg(数値または null): エージェントの平均応答時間(秒単位)。この値には小数点以下の精度が含まれる場合があります。

    • assigned_connection_duration(整数): このセグメント中に割り当てられたエージェントが接続するまで、消費者が待機した時間。

キューの期間

  • queue_durations(配列): オブジェクトの配列。各オブジェクトは、消費者がキューで待機していたチャットのセグメントを表します。

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

    • agent_id(整数または null): エージェント ID。

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

    • lang(文字列): 言語。

    • menu_path_id(整数または null): メニューパス識別子。

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

    • queue_duration(整数または null): キューの継続時間(秒単位)。

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

    • transfer_cold(ブール値または null): チャットが引き継ぎなしで転送されたかどうか。

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

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

    • 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(文字列): チャットがエスカレーションされた理由。値は "unknown"、"by_end_user_ask"、"by_end_user_message"、"by_virtual_agent"、"payload_failure"、"could_not_resume"、"by_human_agent"、"invalid_queue"、"dismissed" のいずれかです。

    • 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(文字列): 偏向されたエスカレーションの偏向タイプ。指定できる値: "no_deflection"、"over_cap"、"over_cap_email"、"over_cap_virtual_agent"、"over_cap_human_agent"、"over_cap_sip"、"over_cap_extension"、"after_hours"、"after_hours_email"、"after_hours_virtual_agent"。

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

    • escalation_reason(文字列): エスカレーションの理由。escalations[].reason と同じ値(10. 仮想エージェントから人間へのエスカレーション)。

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

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

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

    • lang(文字列): 言語。

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

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

  • virtual_agent_handle_durations(配列): チャットが仮想エージェントによって処理された期間のセグメント。

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

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

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

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

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

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

    • response_time_total(整数): 仮想エージェントの合計応答時間(秒)。

    • response_time_max(整数): 仮想エージェントの最長応答時間(秒)。

    • response_time_avg(数値または null): 仮想エージェントの平均応答時間(秒単位)。この値には小数点以下の精度が含まれる場合があります。

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

    • initiated_by(文字列): 仮想エージェント セッションの開始方法。有効な値は "end_user"、"human_agent"、"post_session" です。

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

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

    • lang(文字列): 言語。

    • transfer(ブール値): チャットが転送されたかどうか。

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

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

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

お客様の対応時間

  • consumer_handle_durations(配列): ユーザーがチャットに参加していた時間。

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

    • chat_duration(整数): コンシューマー セグメントの再生時間(秒単位)。

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

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

    • message_count(整数): コンシューマー メッセージの数。

    • response_count(整数): コンシューマー レスポンスの数。

    • response_time_total(整数): コンシューマーの合計レスポンス時間(秒単位)。

    • response_time_max(整数): コンシューマーの最長レスポンス時間(秒単位)。

    • response_time_avg(整数): コンシューマーの平均レスポンス時間(秒)。

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

  • consumer_event_durations(配列): ユーザー チャット イベントの詳細(CSAT、支払いなど)。

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

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

    • type(文字列): イベントタイプ。指定できる値: "csat"。

    • event(文字列): イベントの結果。有効な値: "finished"、"abandoned"。

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

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

    • lang(文字列): 言語。

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

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

参加者

  • participants(配列): チャットの各参加者(エンドユーザー、エージェント、仮想エージェントなど)に関する情報。

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

    • type(文字列): 参加者のタイプ。有効な値は "end_user"、"agent"、"manager"、"virtual_agent"、"external_agent"、"task_virtual_agent" です。

    • entry_type(文字列): 参加者がチャットに参加した方法。有効な値は "queue_or_transfer"、"barge"、"post_session" です。

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

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

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

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

    • status(文字列): 参加者のステータス。値は "waiting"、"connecting"、"invited"、"connected"、"wrapping_up"、"finished"、"failed"、"resuming"、"post_session_in_progress" のいずれかです。

    • fail_reason(文字列): 失敗の理由(該当する場合)。有効な値は、"nothing"、"canceled"、"ag_connection_timeout"、"unknown" です。

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

    • phone_number(文字列): 参加者の電話番号。コンシューマー参加者にのみ表示されます。

    • chat_id(整数): チャットの ID。

    • chat_duration(整数または null): 参加者のチャット時間(秒単位)。

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

    • agent_assist(オブジェクト): 参加者に対して有効な Agent Assist の設定。常に存在します。Agent Assist が構成されていない場合は、空のデフォルト オブジェクトです。

    • virtual_agent(オブジェクトまたは null): この参加者として機能する仮想エージェントの詳細。最上位の agent_info および virtual_agent_params とは異なります。

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

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

    • location_id(整数または null): ロケーションの識別子。エージェント参加者にのみ表示されます。

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

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

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

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

    • teams(配列): エージェントが所属するチームを記述する { id, name } オブジェクトの配列。エージェント参加者にのみ表示されます。

チェックイン ログ

  • check_in_logs(配列): チャット セッション中に記録されたチェックイン イベント。各アイテムは、1 つのチェックイン フローのチェックイン イベントをグループ化します。

    • check_in_id(整数): チェックイン フローの識別子。

    • check_in_modal_displayed(文字列、日時): CCAI プラットフォームがコンシューマにチェックイン モーダルを表示したときのタイムスタンプ。CCAI Platform にチェックイン モーダルが表示された場合にのみ表示されます。

    • check_in_modal_confirmed(文字列、日時): 消費者がまだ在宅であることを確認したときのタイムスタンプ。消費者がチェックイン モーダルを確認した場合にのみ存在します。

    • check_in_modal_timed_out(文字列、日時): チェックイン プロンプトがタイムアウトしたときのタイムスタンプ。チェックイン モーダルがタイムアウトした場合にのみ表示されます。

    • timeout_modal_rejoin_success(文字列、日時): 再参加アクションが成功したときのタイムスタンプ。コンシューマーがタイムアウト後に正常に再参加した場合にのみ存在します。

    • timeout_modal_rejoin_failed_after_hour(文字列、日時): 営業時間外の動作が原因で再参加アクションが失敗したときのタイムスタンプ。キューが営業時間外だったために再参加に失敗した場合にのみ表示されます。

    • timeout_modal_exit_chat(文字列、日時): ユーザーがチャットを終了したときのタイムスタンプ。お客様がタイムアウト モーダルからチャットを終了した場合にのみ表示されます。

    • timeout_modal_time_out_sdk_closed(文字列、日時): SDK が終了したためにタイムアウト モーダル フローが終了したときのタイムスタンプ。タイムアウト後に SDK が終了した場合にのみ表示されます。

イベントを提供する

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

  • offer_events(配列): CCAI Platform がエージェントにチャットを提供したイベント。

    • casting_time(文字列、日時): CCAI プラットフォームがチャットを提供した時刻。

    • group(文字列): CCAI Platform がチャットを提供したグループ。

その他の情報

  • dismiss_duration(整数): チャットが拒否ステータスだった期間(秒単位)。チャットが拒否ステータスで時間を費やした場合にのみ存在します。

  • answer_type(文字列または null): チャットへの応答方法。有効な値は、"manual"、"auto"、"outbound"、"deflection" です。

  • inbound_number(文字列): チャットに関連付けられたインバウンド電話番号。インバウンドの電話番号がチャットに関連付けられている場合にのみ表示されます。

  • outbound_number(文字列): チャットに関連付けられた発信電話番号。チャットに発信電話番号が関連付けられている場合にのみ表示されます。

  • after_hours(ブール値): チャットが営業時間外に行われたかどうか。

  • dispositions(配列): エージェントが記録したまとめコードとメモ。アカウントでまとめコードまたはメモを有効にしている場合にのみ表示されます。各エントリには、ラップアップ構成に基づいて条件付きでレンダリングされるフィールドが含まれる場合があります。

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

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

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

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

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

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

    • ujet_code_id(整数または空の文字列): CCAI Platform によって割り当てられた処理コードの識別子。コードの安定したキー(コードの表示名は変更可能)。利用できない場合は空の文字列。

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

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

    • ujet_list_id(整数または空の文字列): 処理コードが属するリストの CCAI Platform によって割り当てられた識別子。リストの安定したキー。利用できない場合は空の文字列。

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

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

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

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

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

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

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

  • transfer_limit(オブジェクトまたは null): チャットの転送上限データ。

    • enabled(ブール値): チャットで転送制限のトラッキングが有効になっているかどうか。

    • limit_count(整数): 許可される転送数。

    • limit_reached(ブール値): チャットが構成済みの転送上限に達したかどうか。

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

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

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

定義

次のサブスキーマは、チャット セッション メタデータ ドキュメントの複数の場所に表示されます。各サブスキーマは 1 回表示されます。それらを参照するプロパティ グループは、インラインで形状を再定義するのではなく、このセクションを参照します。

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

参照元: 最上位の menu_path フィールド、各 transfers[].from_menu_path と transfers[].to_menu_path、各 escalations[].from_menu_path と escalations[].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、各 participants[].virtual_agent。

deflection(文字列、列挙型)

転送に関連付けられたデフレクションの状態。値は <trigger>_<destination> パターンに従います。接頭辞はデフレクションをトリガーした条件を識別し、接尾辞は宛先または処理を識別します(例: _phone、_voicemail、_message、_queue、_sip、_extension、_callback、_wait)。

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

  • 偏向なし: no_deflection、deflecting

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

  • 営業時間外(メニューに設定された営業時間外にチャットが届いた場合): after_hours_voicemail、after_hours_phone、after_hours_message_only、after_hours_message、after_hours_queue、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

参照元: 各 transfers[].deflection。(仮想エージェントが回避したエスカレーションの仮想エージェントが回避したエスカレーションでは、別の小さな回避語彙を使用します。これについては、インラインで説明しています)。

transfer(オブジェクト)

チャット中に発生した転送について説明します。転送により、メニュー、エージェント、仮想エージェント間でチャットを移動できます。フィールドの完全なリストについては、チャットの転送をご覧ください。

参照元: 最上位の transfers 配列。(ドキュメント全体で transfer_id という名前の他のフィールドは、インライン化された transfer オブジェクトではなく、転送の id への整数参照です)。

participant(オブジェクト)

チャットの 1 人の参加者を表します。参加者の形状は参加者のタイプによって異なります。エージェントの参加者には、エージェント プロファイル、ロケーション、チーム、Agent Assist フィールドを含めることができます。一方、コンシューマーと仮想エージェントの参加者には、タイプ固有の識別子が含まれます。ドキュメント化されたフィールドの完全なリストについては、参加者をご覧ください。

参照元: 最上位の participants 配列、auto_session_summaries[].participant_id、処理レコード。

期間行(オブジェクト)

チャット内で測定された間隔(エージェントの対応時間、キュー時間、消費者の対応時間、消費者のイベント時間、仮想エージェントの対応時間など)を記述します。同じ名前のフィールドでも、テーブルによって精度や null 可能性が異なる場合があるため、各期間配列には独自の行形状があります。

参照元: handle_durations、queue_durations、virtual_agent_handle_durations、consumer_handle_durations、consumer_event_durations。

バージョニングと非推奨

チャット セッションのメタデータ ドキュメントは、下位互換性のあるスキーマの進化を想定して設計されています。新しいフィールドと配列はいつでも追加できます。統合では、認識されないキーを無視して、機能が継続されるようにする必要があります。次のフィールドは、以前のフィールドまたはソフトに置き換えられたフィールドです。下位互換性のためにペイロードに残っていますが、新しい統合ではそれぞれのガイダンスに従う必要があります。

以前の重複

  • session_type(文字列): chat_type の以前のエイリアス。常に chat_type と同じ値を返し、同じ以前の列挙型語彙を使用します。session_type をキーとする統合との下位互換性を維持するために保持されています。新しい統合では、chat_type を直接解析するか、より細かく区別する場合は session_type_v2 を解析する必要があります(下記の語彙の進化を参照)。

語彙の進化

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

  • chat_type は、以前の列挙型語彙を使用しています。Messaging Inbound(App Chat)や Messaging(SMS)などの値は、元のチャットタイプのカテゴリを表します。

  • session_type_v2 は、現在の列挙型語彙を使用します。v2 固有の値を持つチャットタイプに対して、よりきめ細かい区別が導入される可能性があります。v2 固有の値を持たないチャットタイプの場合、session_type_v2 は chat_type と同じ文字列を返します。

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

加算フィールド

チャット セッションのメタデータ ペイロードには、時間の経過とともに、新しい最上位フィールド、ネストされたフィールド、配列アイテム フィールド、列挙値が追加される可能性があります。統合では、認識されないキーを無視し、可能な限り未加工のレコードを保持する必要があります。新しいプロパティが表示されたときに失敗する厳格な解析は避けてください。