このドキュメントでは、チャット セッションのメタデータ レコードのスキーマについて説明します。メタデータ レコードは、コンタクト センター 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: メッセージング インバウンド(アプリチャット)、メッセージング(SMS)、メッセージング(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 using the API)"、"Messaging Inbound (SMS Direct)"、"Messaging Outbound (SMS Direct)"、"Messaging Outbound (SMS Direct using the 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 プラットフォームがチャット セッションを作成したときのタイムスタンプ。assigned_at(文字列、日時、または null): CCAI プラットフォームがチャットをエージェントに割り当てたときのタイムスタンプ。割り当てられていない場合は null。ends_at(文字列、日時、または null): チャット セッションが終了したときのタイムスタンプ。updated_at(文字列、日時): CCAI プラットフォームがチャットデータを最後に更新したときのタイムスタンプ。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 システムで作成したチケットの ID。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): 仮想エージェントのアバター画像の URL。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): エージェントの ID。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): エージェントの識別子。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(整数): チャットの識別子。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(文字列、日時): 消費者がまだ Present であることを確認したときのタイムスタンプ。消費者がチェックイン モーダルを確認した場合にのみ存在します。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 プラットフォームがエージェントにチャットを提供した方法。offer_events(配列): CCAI プラットフォームがエージェントにチャットを提案したイベント。casting_time(文字列、日時): CCAI プラットフォームがチャットを提供した時刻。group(文字列): CCAI プラットフォームがチャットを提供したグループ。
その他の情報
dismiss_duration(整数): チャットが非表示状態だった期間(秒単位)。チャットが終了ステータスで時間を費やした場合にのみ存在します。answer_type(文字列または null): チャットの回答方法。有効な値:"manual"、"auto"、"outbound"、"deflection"。inbound_number(文字列): チャットに関連付けられた着信電話番号。着信の電話番号がチャットに関連付けられている場合にのみ表示されます。outbound_number(文字列): チャットに関連付けられた発信電話番号。発信電話番号がチャットに関連付けられている場合にのみ表示されます。after_hours(ブール値): チャットが営業時間外に行われたかどうか。dispositions(配列): エージェントが記録したまとめコードとメモ。アカウントでまとめコードまたはメモを有効にした場合にのみ表示されます。各エントリには、まとめの構成に基づいて条件付きでレンダリングされるフィールドが含まれる場合があります。user_id(整数): エージェントの識別子。transfer_id(整数または null): 転送後に記録された場合の転送イベント識別子。participant_id(整数): 参加者の識別子。note(文字列): エージェントのメモ(自由形式)。original_note(文字列): メモの元の(編集前の)バージョン。code(文字列): 処分コード名。ujet_code_id(整数または空の文字列): CCAI Platform によって割り当てられた処分コードの識別子。コードの安定したキー(コードの表示名は変更される可能性があります)。利用できない場合は空の文字列。list(文字列): コードが属するリストの名前。list_path(文字列): コードリストのパス(スラッシュ区切り)。ujet_list_id(整数または空の文字列): 処分コードが属するリストの CCAI Platform 割り当て ID。リストの安定したキー。利用できない場合は空の文字列。custom_list_id(文字列または整数): マッピングされている場合は、顧客定義のリスト識別子。custom_code_id(文字列または整数): マッピングされている場合は、顧客定義のコード識別子。
auto_session_summaries(配列): CRM レコードに保存された AI 生成のセッションの要約。アカウントで会話の要約を有効にし、AI が要約を正常に生成した場合にのみ存在します。各エントリには次のものが含まれます。user_id(整数): 要約が関連付けられているエージェント参加者の ID。participant_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(オブジェクト)
チャットがたどった階層メニューパスを説明します。フィールドの完全なリストについては、メニュー ナビゲーションをご覧ください。
参照元: 最上位の 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_extensionIVR 事前セッション:
ivr_presession_deflection仮想エージェントがチャットをリダイレクトした場合の仮想エージェントのリダイレクト:
va_redirection_phone、va_redirection_sip
参照元: 各 transfers[].deflection。(仮想エージェントによって削減されたエスカレーションの仮想エージェントによって削減されたエスカレーションでは、別の小さな削減語彙を使用します。これは、インラインで文書化されています)。
transfer(オブジェクト)
チャット中に発生した転送について説明します。転送により、メニュー、エージェント、仮想エージェント間でチャットを移動できます。フィールドの完全なリストについては、チャット転送をご覧ください。
参照元: 最上位の transfers 配列。(ドキュメント全体で transfer_id という名前の他のフィールドは、転送の id への整数参照であり、インライン transfer オブジェクトではありません)。
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 プラットフォームは、すべてのレコードで両方のフィールドを出力します。これらは重複していません。
chat_typeは、以前の列挙型語彙を使用します。「Messaging Inbound (App Chat)」や「Messaging (SMS)」などの値は、元のチャットタイプのカテゴリを表します。session_type_v2は現在の列挙型語彙を使用します。v2 固有の値を持つチャットタイプに対して、より細かい区別が導入される可能性があります。v2 固有の値がないチャットタイプの場合、session_type_v2はchat_typeと同じ文字列を返します。
新しい統合では、session_type_v2 を解析する必要があります。各フィールドの値については、基本情報をご覧ください。
加法体
チャット セッション メタデータのペイロードには、時間の経過とともに新しいトップレベル フィールド、ネストされたフィールド、配列アイテム フィールド、列挙値が追加される可能性があります。統合では、認識されないキーは無視し、可能な限り未加工のレコードを保持する必要があります。新しいプロパティが表示されたときに失敗する厳密な解析を回避します。