このドキュメントでは、通話セッション メタデータ レコードのスキーマについて説明します。これは、UJET が音声通話の終了時に出力する JSON ドキュメントです。UJET は、セッション終了コマンドの本文としてレコードを CRM 統合に配信し、レコードを metadata.json ファイルとして外部ストレージ構成に書き込みます。各呼び出しで 1 つのレコードが生成されます。最上位の id は、各レコードを一意に識別します。このスキーマを使用して、レコードをダウンストリーム システムに取り込み、受信したペイロードを検証し、フィールドをデータ ウェアハウスの列にマッピングします。
スキーマ ルート
通話セッション メタデータ レコードは、音声通話セッションを表す単一の JSON オブジェクトです。最上位の 3 つのコンセプトによって、レコードの ID と形状が決まります。
主キー - id(整数)
最上位の id は、テナント内の通話セッションを一意に識別します。呼び出しごとに 1 つのレコードが存在します。他のすべてのトップレベルのフィールド、配列、ネストされたオブジェクトは、この id が識別する呼び出しの属性を表します。
ハンドラ識別子 - agent_info(オブジェクト、oneOf)
呼び出しの最後のハンドラに応じて形状が変化する単一のオブジェクト。この 2 つのバリアントは相互に排他的です。レコードには 1 つのバリアントのみが含まれます。
人間のエージェント バリエーション - 人間のエージェントが最後に通話を処理した場合に表示されます。共有の
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 をご覧ください。
呼び出し形状の判別子 - call_type、session_type、session_type_v2(文字列)
同じ基盤となる通話タイプの 3 つの並列ビュー。レコードが表す呼び出しタイプについて意見が一致しないことはありません。呼び出しタイプに名前を付けるために使用する語彙が異なるだけです。
call_typeは以前の列挙型語彙(Voice Inbound (App)、Voice Outbound、Voice Internalなど)を使用します。session_typeは常にcall_typeと同じ文字列を返します。UJET は、このフィールドをキーとする統合との下位互換性を確保するために提供しています。call_typeの非推奨のエイリアスとして扱ってください。バージョニングと非推奨をご覧ください。session_type_v2は現在の列挙型語彙を使用します。この語彙は、より細かいインバウンドの区別(たとえば、より広範なVoice Inbound (App)やVoice Inbound (IVR using App)の代わりにVoice Inbound (Mobile)やVoice Inbound (IVR using Mobile))でcall_type語彙を拡張します。v2 固有の値がない呼び出しタイプの場合、session_type_v2はcall_typeと同じ文字列を返します。新しい統合では、session_type_v2を解析する必要があります。
各フィールドの値については、コア情報をご覧ください。
基本情報
これらのプロパティは、通話のコア情報をキャプチャします。
id(整数): 各通話セッションの一意の識別子。これは、通話を区別する主キーです。call_uuid(文字列または null): 動的通話ルーティング(DCR)インタラクションで、発信元テナントと受信テナント間の通話を関連付ける一意の識別子。DCR 呼び出しの両方のレッグが同じcall_uuid値を共有するため、お客様は環境間でデータをブリッジできます。DCR インタラクションではない通話、および UJET がフィールドを追加する前に行われた通話の場合、フィールドは null または空になります。lang(文字列): 通話の ISO 639 言語コード(英語の場合は「en」、スペイン語の場合は「es」など)。このコードは、言語固有の分析とレポート作成に役立ちます。call_type(文字列): 以前のタイプの語彙を使用した呼び出しのタイプ。値には、「Voice Inbound (App)」、「Voice Inbound (Web)」、「Voice Inbound (IVR)」、「Voice Inbound (IVR using 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 (<ブランド名>)」、「Agent Scheduled Call」などがあります。session_type(文字列): 下位互換性を維持するために UJET が保持しているcall_typeの複製(同じ値)。バージョニングと非推奨: 以前の重複をご覧ください。session_type_v2(文字列): 現在のタイプの語彙を使用した、通話のタイプ。call_type値をより詳細なインバウンドの区別(「音声インバウンド(アプリ)」と「音声インバウンド(アプリを使用した IVR)」の代わりに「音声インバウンド(モバイル)」と「音声インバウンド(モバイルを使用した IVR)」など)で絞り込みます。値には、「Voice Inbound (Mobile)」、「Voice Inbound (Web)」、「Voice Inbound (IVR)」、「Voice Inbound (IVR using 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」、「queued」、「connected」、「finished」、「failed」、「deflected」です。これにより、ライフサイクルにおける呼び出しの進行状況を追跡できます。created_at(文字列、日時): UJET が通話記録を作成した正確なタイムスタンプ。queued_at(文字列、日時、または null): 通話がキューに入ったときのタイムスタンプ。通話がキューに入らなかった場合は null。assigned_at(文字列、日時、または null): UJET が通話をエージェントに割り当てたときのタイムスタンプ。UJET が通話を割り当てなかった場合は null。connected_at(文字列、日時、または null): 通話が接続されたときのタイムスタンプ。ends_at(文字列、日時、または null): 通話が終了したときのタイムスタンプ。scheduled_at(文字列、日時、または null): UJET が通話をスケジュールしたときのタイムスタンプ。通話が即時だった場合は null。updated_at(文字列、日時): UJET が通話データを最後に更新したときのタイムスタンプ。wait_duration(整数または null): 通話全体で消費者がキューで待機した合計時間(秒)。UJET がキュー時間を記録していない場合は null。個々のセグメント別のキュー時間については、queue_durations配列(キューの所要時間)をご覧ください。バージョニングと非推奨: 待機時間フィールドの命名規則をご覧ください。call_duration(整数または null): 通話の合計時間(秒単位)。hold_duration(整数または null): お客様が保留になった合計時間(秒単位)。保留時間がなかった場合は null。rating(整数または null): 消費者が送信した顧客満足度(CSAT)の評価。消費者が評価を送信しなかった場合は null。has_feedback(ブール値): 通話後にお客様がフィードバックを提供したかどうかを示すフラグ。voip_provider(文字列): 通話の VoIP プロバイダ。(注: このフィールドは非推奨であり、常に「deprecated」を返します)。out_ticket_id(文字列または null): UJET が外部 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」、「temporary_redirection」、「after_hour_deflection」があります。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、eu_canceled、eu_rejected、eu_abandoned、eu_in_menu_abandoned、eu_busy、eu_wrong_number、eu_no_answer、eu_noti_failed、ag_canceled、ag_ignored、ag_mic_no_device、ag_mic_denied、voip_twilio_error、voip_tokbox_error、voip_invalid_token、voip_conn_general、voip_conn_timeout、voip_conn_signalです。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): 仮想エージェントのアバター画像の URL。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(オブジェクト。データ パラメータを有効にしてセッション メタデータに含めるように設定した場合にのみ存在します): アカウントの外部 API 設定で設定した、通話のデータ パラメータ値のスナップショット。キーと値の型は、データ パラメータの構成によって異なります。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(配列): 通話中の回避に関する詳細なログを提供します。各エントリ内の偏向フィールドは、定義: 偏向で定義された列挙型を使用します。各エントリには次のものが含まれます。id(整数): 転換ログレコードの固有識別子。call_id(整数): 通話の固有識別子。transfer_id(整数または null): たらい回しに関連付けられた転送の一意の識別子(該当する場合)。deflection(文字列。使用可能な値については、定義: 転換を参照): 転換のタイプ。created_at(文字列、日時): 偏向が発生したときのタイムスタンプ。from_menu_path(オブジェクトまたは null): たらい回しが開始されたメニューパス。to_menu_path(オブジェクトまたは null): UJET が通話を転送したメニューパス。to_sip_uri(文字列。UJET が通話を SIP 宛先に転送した場合にのみ存在します): UJET が通話を転送した SIP URI(該当する場合)。to_sip_headers(オブジェクト。UJET が通話を SIP の宛先に転送した場合にのみ存在します): UJET が通話を転送した SIP ヘッダー(該当する場合)。
転送
transfers(配列): 通話中の転送イベントごとに 1 つのエントリ。エージェント、バーチャル エージェント、メニュー間の引き継ぎありの転送と引き継ぎなしの転送の両方を記録します。id(整数): 転送の一意の識別子。status(文字列): 転送の現在のステータス(転送中、接続済み、失敗など)。fail_reason(文字列): 転送が失敗した理由。失敗しなかった場合は「nothing」。created_at(文字列、日時): 転送が開始された日時。assigned_at(文字列、日時、または null): UJET が転送を転送先に割り当てた日時。connected_at(文字列、日時、または null): 転送が接続された日時。updated_at(文字列、日時): UJET が転送レコードを最後に更新した日時。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(boolean または null): 引き継ぎなしの転送だったかどうか。started_at(文字列、日時): 開始タイムスタンプ。ended_at(文字列、日時、または null): 終了タイムスタンプ。scheduled_at(文字列、日時、または null): スケジュールされたタイムスタンプ。hold_duration(整数または null): このセグメント中の保留時間。assigned_connection_duration(整数): このフェーズでエージェントが接続する間、消費者が待機した時間。session_breakthrough(オブジェクト。エージェントのステータスが [Unavailable] のときに通話が割り当てられた場合にのみ存在します): エージェントのステータスが [Unavailable] のときに通話が割り当てられた場合の割り当ての詳細(該当する場合)。
キューの期間
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(文字列): 現在のステータス(エスカレーション中、エスカレーション済み、失敗など)。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(文字列): 転換タイプ。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
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(オブジェクト。エージェント アシストを構成した場合にのみエージェント参加者に存在します): この参加者のアクティブなエージェント アシスト設定。virtual_agent(オブジェクト。仮想エージェントの参加者のみに存在): この参加者として機能する仮想エージェントの詳細。最上位のagent_infoおよびvirtual_agent_paramsとは異なります。caller_id(文字列。アカウントで SIP ヘッダー発信者 ID を有効にしている場合、一般ユーザーの参加者に対してのみ存在します): この一般ユーザーの参加者に対して UJET が着信 SIP ヘッダーから抽出した発信者 ID。sip_headers(オブジェクトまたは null): この参加者に関連付けられた SIP ヘッダー。ペイロードに常に存在します。UJET がヘッダーをキャプチャしない場合は 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 プロバイダの通話識別子。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(整数または文字列): セグメントに関連付けられた仮想エージェントの ID(存在する場合)。conversation_id(文字列): この録音を会話レコードに関連付ける識別子。
segments(配列。アカウントで後処理された分析情報録画を有効にした場合にのみ存在します): システムがダウンストリームの分析情報パイプライン用に生成する、参加者ごとの音声(およびオプションの画面録画)セグメント。id(整数): セグメントの固有識別子。call_id(整数): 呼び出し ID。duration(整数): セグメントの長さ(秒単位)。started_at(文字列、日時): セグメントの開始タイムスタンプ。audio_file_name(文字列): セグメントの音声アセットのファイル名。audio_url(文字列、URI): セグメントの音声ファイルへの URL。agent_id(整数または文字列): セグメントに関連付けられたエージェントの ID。virtual_agent_id(整数または文字列): セグメントに関連付けられた仮想エージェントの ID(存在する場合)。participant_id(整数または文字列): セグメントが属する参加者の識別子。conversation_id(文字列): このセグメントを会話レコードに関連付ける識別子。screen_recording_url(文字列、URI、または null): 一致する画面録画アセットの URL。アカウントで画面録画を有効にした場合にのみ表示されます。screen_recording_file_name(文字列または null): 画面録画のファイル名。screen_recording_urlと同じ条件で提示します。
オファー イベント
offer_type(文字列または null): UJET がエージェントに電話をどのように提供したか。offer_events(配列): UJET がエージェントに通話を提案したときのイベント。casting_time(文字列、日時): UJET が通話を提供した時間。group(文字列): UJET が通話を提供したグループ。
その他の情報
answer_type(文字列または null): 通話が解決された方法(「manual」または「auto」)。outbound_number(文字列または null): 使用された発信電話番号。wait_time_sms(配列。この通話で待ち時間に関する SMS のやり取りが発生した場合にのみ存在します): UJET が消費者に送信した、予想待ち時間に関する 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(ブール値): UJET がプリセット メッセージを送信したかどうか。custom_sent(ブール値): エージェントがカスタム(フリーテキスト)メッセージを送信したかどうか。received(ブール値): UJET がお客様から SMS を受信したかどうか。
dispositions(配列。アカウントで終了コードまたはメモを有効にしている場合にのみ存在します): エージェントが記録した終了コードとメモ。各エントリには、まとめの構成に基づいて動的にレンダリングされたフィールドが含まれます。user_id(整数): エージェントの識別子。transfer_id(整数または null): 転送後に記録された場合の転送イベント識別子。participant_id(整数): 参加者の識別子。note(文字列): エージェントのメモ(自由形式)。original_note(文字列): メモの元の(編集前の)バージョン。code(文字列): 処分コード名。ujet_code_id(整数または空の文字列): 処分コードの UJET ID。コードの安定したキーです(コードの表示名は変更できます)。利用できない場合は空の文字列。list(文字列): コードが属するリストの名前。list_path(文字列): コードリストのパス(スラッシュ区切り)。ujet_list_id(整数または空の文字列): 処分コードが属するリストの UJET 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 回の VA エスカレーションが発生した場合にのみ存在します): エスカレーション後に UJET が仮想エージェントを保持している間、消費者がキューで待機した時間間隔。各エントリには次のものが含まれます。start(文字列、日時): キューでの待機が開始された日時。end(文字列、日時、または null): キューの待機が終了した日時。完了しなかった場合は null。duration(整数または null): 待機時間(秒)。endが null の場合は null。
auto_session_summaries(配列。アカウントで会話の要約を有効にし、UJET が要約を正常に生成した場合にのみ存在します): UJET が CRM レコードに保存する AI 生成のセッションの要約。各エントリには次のものが含まれます。user_id(整数): 要約が関連付けられているエージェント参加者の ID。participant_id(整数): 参加者の識別子。session_summary(文字列): 概要テキスト。session_summary_sections(配列またはオブジェクト): 構造化されたセクションの概要(利用可能な場合)。
sip_headers(オブジェクト。アカウントで SIP ヘッダー キャプチャを有効にして、セッション メタデータに含めるように構成した場合にのみ存在します): 通話用に UJET がキャプチャしたインバウンド SIP ヘッダー。キーと値には、アップストリームのテレフォニー プロバイダから受信した SIP ヘッダーが反映されます。
定義
このセクションでは、各サブスキーマを 1 回定義します。サブスキーマを参照するプロパティ グループは、シェイプをインラインで再定義するのではなく、これらの定義にリンクします。
menu_path(オブジェクト)
通話がたどった階層メニューパスを説明します。フィールドの完全なリストについては、メニュー ナビゲーションをご覧ください。
参照元: 最上位の 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(文字列、列挙型)
通話または通話セグメントの回避状態。値は <trigger>_<destination> という命名パターンに従います。接頭辞は、転送をトリガーした条件(容量超過、営業時間外、一時的なリダイレクトなど)を示し、接尾辞は、転送先または処理(ボイスメール、キュー、電話、メッセージなど)を示します。
一般的な宛先サフィックス:
_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_sip、over_cap_extension、over_cap_phone_with_extension。営業時間外 - メニューの営業時間外に電話がかかってきた場合:
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 フィールド、各 deflection_details[].deflection、各 transfers[].deflection。
バージョニングと非推奨
通話セッションのメタデータ スキーマは、下位互換性のある進化をサポートしています。UJET は、いつでも新しいフィールドと配列を追加できます。連携では、機能の継続性を確保するために、認識されないキーを無視する必要があります。このセクションのフィールドは、非推奨、レガシー、またはソフト置換です。下位互換性のためにペイロードに残りますが、新しい統合では各フィールドのガイダンスに従う必要があります。
非推奨のフィールド
voip_provider(文字列) - 非推奨。常にリテラル文字列「deprecated」を返します。UJET は、このドキュメントを通じてインテグレーションにプロバイダ情報を表示しなくなりました。代替フィールドはありません。統合でアップストリームの電話プロバイダを特定する必要がある場合は、アカウント チームにお問い合わせください。
以前の重複
session_type(文字列)-call_typeのレガシー エイリアス。常にcall_typeと同じ値を返し、同じレガシー列挙型語彙を使用します。UJET は、session_typeをキーとする統合との下位互換性を維持するために、このフィールドを保持しています。新しい統合では、call_typeを直接解析するか、よりきめ細かいインバウンドの区別を行う場合はsession_type_v2を解析する必要があります(下記の語彙の進化を参照)。
語彙の進化
call_type と session_type_v2 は、2 つの異なる語彙を使用して同じ基盤となる呼び出しタイプを記述します。UJET はすべてのレコードで両方のフィールドを出力します。これらは重複していません。
call_typeは、以前の列挙型語彙を使用します。Voice Inbound (App)やVoice Inbound (IVR using App)などの値は、モバイルとアプリ内 SDK のすべてのインバウンド元を 1 つのラベルでカバーします。call_typeは非推奨ではありません。UJET はこのフィールドの出力を継続しますが、その語彙に新しいきめ細かい値は追加されません。session_type_v2は現在の列挙型語彙を使用します。v2 固有の値を持つ呼び出しタイプに対して、よりきめ細かいインバウンドの区別(Voice Inbound (Mobile)やVoice Inbound (IVR using Mobile)など)を導入します。v2 固有の値がない呼び出しタイプの場合、session_type_v2はcall_typeと同じ文字列を返します。
新しい統合では、session_type_v2 を解析する必要があります。各フィールドの値については、基本情報をご覧ください。
待機時間フィールドの命名規則
通話セッション メタデータ ドキュメントでは、キューの待ち時間が 2 つのスコープで 2 つのフィールド名で報告されます。
通話の合計 - 最上位の
wait_durationフィールドには、通話全体で消費者がキューで待機した合計時間が保持されます。セグメントごと - 最上位の
queue_durations配列(キューの所要時間)の各エントリには、個々のキュー セグメントのキュー時間を保持する独自のqueue_durationフィールドが含まれています。
どちらの名前も、異なるスコープで同じ種類の測定(キューで費やした時間)を指します。通話の合計 wait_duration は消費者のキューでの合計待機時間を反映し、セグメントごとの queue_duration 値は各キュー セグメントを表します。このドキュメントでは、個別の最上位の queue_duration フィールドは出力されません。セグメントごとの値は queue_durations 内でのみ使用できます。