通話工作階段中繼資料

本文提供通話工作階段中繼資料記錄的結構定義,也就是 UJET 在每次語音通話結束時發出的 JSON 文件。UJET 會將記錄傳送至 CRM 整合服務,做為會話結束指令的主體,並將記錄寫入外部儲存空間設定,做為 metadata.json 檔案。每次呼叫都會產生一筆記錄。頂層 id 可用來識別每筆記錄。您可以使用這個結構定義,將記錄匯入下游系統、驗證收到的酬載,或將欄位對應至資料倉儲資料欄。

結構定義根層級

通話工作階段中繼資料記錄是代表語音通話工作階段的單一 JSON 物件。頂層有三個概念,可決定記錄的 ID 和形狀。

主鍵 - id (整數)

頂層 id 可在租戶中唯一識別通話工作階段。每通電話會有一筆記錄。所有其他頂層欄位、陣列和巢狀物件都會說明此 id 識別的通話屬性。

處理常式鑑別器 - agent_info (物件,oneOf)

單一物件,形狀取決於呼叫的最後一個處理常式。這兩個變體互斥,記錄只會包含一個變體:

  • 真人服務專員變體:如果通話最後是由真人服務專員處理,就會顯示這個變體。 除了共用的 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 (字串)

同一基礎呼叫類型的三個平行檢視畫面。兩者在記錄代表的通話類型上絕不會有歧異,只會使用不同的詞彙來命名通話類型。

  • call_type 使用舊版列舉詞彙 (例如 Voice Inbound (App)、Voice Outbound 或 Voice Internal)。

  • session_type 一律會傳回與 call_type 相同的字串。UJET 提供這個欄位,是為了與以這個欄位為鍵的整合項目保持回溯相容性;請將這個欄位視為 call_type 的已淘汰別名。請參閱「版本管理和淘汰」。

  • session_type_v2 使用目前的列舉詞彙。這個詞彙表會擴充 call_type 詞彙表,提供更精細的傳入區別,例如 Voice Inbound (Mobile) 和 Voice Inbound (IVR using Mobile),取代範圍較廣的 Voice Inbound (App) 和 Voice Inbound (IVR using App)。如果通話類型沒有專屬的 v2 值,session_type_v2 會傳回與 call_type 相同的字串。新的整合應剖析 session_type_v2。

如要瞭解每個欄位的值,請參閱「核心資訊」。

核心資訊

這些屬性會擷取通話的核心資訊:

  • id (整數):每個通話工作階段的專屬 ID。這是區分不同呼叫的主要金鑰。

  • call_uuid (字串或空值):專屬 ID,用於在動態通話轉送 (DCR) 互動中,將通話與來源和接收端租戶建立關聯。DCR 呼叫的兩條路徑會共用相同的 call_uuid 值,方便顧客在不同環境之間橋接資料。如果通話不是 DCR 互動,或是通話發生在 UJET 新增該欄位之前,則該欄位為空值或空白。

  • 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 (字串):call_type 的副本 (值相同),UJET 會保留這個副本,確保回溯相容性。請參閱「版本管理和淘汰項目:舊版重複項目」。

  • 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 (<your brand name>)」和「Agent Scheduled Call」。

  • status (字串):通話的目前狀態。可能的值包括「scheduled」、「queued」、「connected」、「finished」、「failed」和「deflected」。這會追蹤通話在生命週期中的進展。

  • created_at (字串,日期時間):UJET 建立通話記錄的確切時間戳記。

  • queued_at (字串、日期時間或空值):通話進入佇列的時間戳記,如果通話未進入佇列,則為空值。

  • assigned_at (字串、日期時間或空值):UJET 將通話指派給服務專員的時間戳記;如果 UJET 未指派通話,則為空值。

  • connected_at (字串、日期時間或空值):通話連線的時間戳記。

  • ends_at (字串、日期時間或空值):通話結束的時間戳記。

  • scheduled_at (字串、日期時間或空值):UJET 排定通話時間的時間戳記,如果通話是立即進行,則為空值。

  • updated_at (字串,日期時間):UJET 上次更新通話資料的時間戳記。

  • wait_duration (整數或空值):消費者在整個通話期間等待佇列的時間總計 (以秒為單位),如果 UJET 未記錄任何佇列時間,則為空值。如要查看按個別區隔劃分的佇列時間,請參閱 queue_durations 陣列 (Queue durations)。請參閱版本管理和淘汰項目:等待時間欄位命名。

  • call_duration (整數或空值):通話總時間長度 (以秒為單位)。

  • hold_duration (整數或空值):消費者等待的總時間 (以秒為單位),如果沒有等待時間,則為空值。

  • rating (整數或空值):消費者提交的顧客滿意度 (CSAT) 評分,如果消費者未提交評分,則為空值。

  • has_feedback (布林值):指出消費者是否在通話後提供意見回饋的旗標。

  • voip_provider (字串):通話的 VoIP 服務供應商。(注意:這個欄位已淘汰,一律會傳回「deprecated」)。

  • out_ticket_id (字串或空值):UJET 在外部 CRM 系統中建立的票證 ID。

  • out_ticket_url (字串、URI 或空值):CRM 服務單的網址。

  • is_out_ticket_account (布林值或空值):指出 CRM 服務單代表客戶 (true) 或通話互動 (false)。

  • verified (布林值):指出驗證智慧動作是否已驗證互動。

  • recording_url (字串、URI 或空值):電話錄音的網址,如果沒有錄音檔,則為空值。

  • recording_permission (字串或空值):消費者的錄音權限狀態。可能的值為「not_asked」、「granted」、「denied」。

  • voicemail_reason (字串):語音留言的原因 (如適用)。 選項包括「not_voicemail」、「temporary_redirection」和「after_hour_deflection」。

  • disconnected_by (字串或空值):指出哪一方結束通話。 可能的值:disconnected_by_unknown、disconnected_by_agent、disconnected_by_end_user、disconnected_by_virtual_agent、disconnected_by_system。

  • fail_reason (字串或空值):通話失敗的原因,或通話未失敗時的「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 (字串或空值):可供使用者閱讀的額外詳細資料,如有則會隨附於 fail_reason。

  • adapter_fail_code (整數或空值):與呼叫層級的 fail_reason 對應的數字代碼。如果呼叫未失敗,則為空值。每個參與者在第 17 節中都使用相同的 adapter_fail_code 列舉。

  • adapter_fail_message (字串或空值):對應 adapter_fail_code 的訊息,方便使用者閱讀。如果呼叫未失敗,則為空值。

  • support_number (字串或空值):消費者撥打的電話號碼,格式為 E.164,可聯絡客服中心。適用於 IVR 發起的通話;其他管道可能為空值。

  • queue_priority_level (整數;只有在帳戶啟用佇列優先順序時才會顯示):指派給通話的佇列優先順序。

服務專員和虛擬代理資訊

這些部分會說明通話的處理對象或方式:

  • agent_info (物件):這個欄位可以保存真人或虛擬代理人的相關資訊。並使用 oneOf 關鍵字指定可為兩種型別之一。

    • agent (物件):真人服務專員的相關資訊:

      • id (整數):代理的專屬 ID。

      • agent_number (字串或空值):指派給代理程式的 ID。

      • email (字串,電子郵件):代理的電子郵件地址。

      • name (字串):代理人的全名。

      • last_name (字串):代理人的姓氏。

      • first_name (字串):代理商的名字。

      • avatar_url (字串,URI):代理程式顯示圖片的網址。

    • virtual_agent (物件):虛擬代理的相關資訊:

      • id (整數):虛擬代理程式的專屬 ID。

      • name (字串):虛擬代理人的名稱。

      • avatar_url (字串、URI 或空值):虛擬代理程式的虛擬人偶圖片網址。

      • va_alias (字串或空值):虛擬代理程式的顯示別名 (如有設定)。一律會出現在酬載中;如果未設定別名,則為空值。

  • selected_menu (物件或空值):消費者在通話期間選取的菜單相關資訊。

    • id (整數):菜單的專屬 ID。

    • name (字串):選單名稱。

    • parent_id (整數或空值):父項選單的 ID (如有)。

    • position (整數):相對於同一層級的其他選單,這個選單的位置。

    • deleted (布林值):選單是否已刪除。

    • menu_type (字串):選單類型 (例如 ivr_menu 或 sms_menu)。

    • hidden (布林值):選單是否顯示且可供使用。

  • menu_path (物件或空值):說明消費者瀏覽的選單階層路徑。

    • items_count (整數):路徑中的選單數量。

    • name (字串):以斜線分隔的選單名稱字串 (例如「Support/Billing」)。

    • materialized_path (字串):以斜線分隔的選單 ID 字串。

  • automation_redirection (物件;只有在通話的第一個轉接記錄與重新導向群組相關聯時才會顯示):影響這通電話路徑的百分比式佇列重新導向詳細資料。

    • percent_redirection (布林值):您是否在來源選單中啟用百分比式重新導向。

    • redirection_group (陣列):包含重新導向群組詳細資料的單一元素陣列:

      • group_label (字串):重新導向群組的使用者可理解標籤 (例如「重新導向群組 1」)。

      • destination (物件或空值):您在群組中設定的重新導向目的地。

      • after_hours (布林值或空值):是否已在群組中啟用下班後轉接選項。

      • ah_destination (物件或空值):您在群組中設定的下班後轉接目的地。

使用者詳細資料

  • end_user (物件或空值):消費者資訊:

    • id (整數或空值):消費者的內部 ID。

    • identifier (字串或空值):消費者的外部 ID。

    • out_contact_id (字串或空值):消費者在 CRM 中的 ID。

自訂資料和 SDK 提供的資料

  • customer_flag (物件;僅在網站傳遞自訂驗證資料時顯示):消費者應用程式或網站在工作階段開始時傳遞的驗證相關自訂資料屬性。酬載只會包含您指定為驗證參數的子集。

  • api_dap_request (物件;只有在啟用資料參數並設定將其納入工作階段中繼資料時才會顯示):通話的資料參數值快照,如您在帳戶的外部 API 設定中設定。鍵和值類型取決於資料參數設定。

  • form_responses (陣列;只有在消費者提交至少一份表單回覆時才會顯示):通話期間 SDK 表單收集的回覆。每個項目都包含:

    • id (字串或整數):表單回覆 ID。

    • title (字串):向消費者顯示的表單標題。

    • smart_action_id (整數或空值):觸發表單的智慧動作 ID (如有)。

    • questions (陣列):收集到的常見問答。

附件

  • photos (陣列):消費者在通話期間上傳的照片。

    • id (整數):相片的專屬 ID。

    • photo_type (字串):相片的類型或來源 (例如「photo」)。

    • url (字串、URI):儲存相片的網址。

    • smart_action_type (字串或空值):產生相片的智慧動作 (如有)。

    • transfer_id (整數或空值):相片的轉移事件 ID (如果消費者是在轉移後上傳相片)。

  • videos (陣列):消費者在通話期間上傳的影片。

    • id (整數):影片的專屬 ID。

    • url (字串、URI):儲存影片的網址。

    • smart_action_type (字串或空值):產生影片的智慧動作 (如有)。

    • transfer_id (整數或空值):影片的轉移事件 ID (如果消費者是在轉移後上傳影片)。

通話轉接

  • deflection (字串):指出通話是否轉接,以及轉接方式 (例如「no_deflection」、「over_cap_phone」或「after_hours_voicemail」)。

  • deflection_details (陣列):提供通話期間轉接的詳細記錄。每個項目的 deflection 欄位都會使用「定義:偏轉」中定義的列舉。每個項目都包含:

    • id (整數):轉移記錄項目的專屬 ID。

    • call_id (整數):通話的專屬 ID。

    • transfer_id (整數或空值):與轉接相關聯的轉移作業專屬 ID (如適用)。

    • deflection (字串;如需允許的值,請參閱「定義:轉移」):轉移類型。

    • created_at (字串,日期時間):發生偏斜的時間戳記。

    • from_menu_path (物件或空值):開始轉移的選單路徑。

    • to_menu_path (物件或空值):UJET 將通話轉接至的選單路徑。

    • to_sip_uri (字串;僅在 UJET 將通話轉接至 SIP 目的地時顯示):UJET 將通話轉接至的 SIP URI (如適用)。

    • to_sip_headers (物件;僅在 UJET 將通話轉接至 SIP 目的地時顯示):UJET 用來轉接通話的 SIP 標頭 (如適用)。

移轉

  • transfers (陣列):通話期間的每個轉移事件各有一筆記錄。記錄專員、虛擬服務專員和選單之間的熱轉移和冷轉移。

    • id (整數):轉移作業的專屬 ID。

    • status (字串):轉移作業的目前狀態 (例如轉移中、已連線或失敗)。

    • fail_reason (字串):轉移失敗的原因,如果沒有失敗則為「nothing」。

    • created_at (字串,日期時間):移轉作業的開始時間。

    • assigned_at (字串、日期時間或空值):UJET 將轉移作業指派給接收方時。

    • connected_at (字串、日期時間或空值):轉移作業連線時。

    • updated_at (字串,日期時間):UJET 最近一次更新轉移記錄的時間。

    • call_duration (整數):轉移區段的通話時間長度 (以秒為單位)。

    • wait_duration (整數):消費者在轉接期間等待的時間 (以秒為單位)。

    • deflection (字串):與轉移相關聯的轉移類型 (如有)。

    • answer_type_path (字串或空值):說明轉移的通話如何解決的路徑。

    • from_menu_path / to_menu_path (物件或空值):轉移前後的選單路徑;與「定義」中的 menu_path 相同。

    • from_agent / to_agent (物件或空值):轉移程序中每一端的真人服務專員;與「定義」中的 agent 物件形狀相同。

    • from_virtual_agent / to_virtual_agent (物件或空值):轉移兩端的虛擬代理人;與「定義」中的 virtual_agent 物件形狀相同。

    • from_queue_priority_level / to_queue_priority_level (整數或空值):轉移前後的佇列優先順序。只有在帳戶中啟用佇列優先順序時才會顯示。

通話處理時間長度

  • handle_durations (陣列):物件陣列,每個物件代表通話中由服務專員處理的一段對話。這有助於分析代理程式處理時間。

    • id (整數):處理時間的專屬 ID。

    • agent_id (整數):代理程式的 ID。

    • acw_duration (整數):通話後處理時間。

    • bcw_duration (整數):通話前工作時間長度。

    • call_duration (整數):這個區段的通話時間長度。

    • menu_path_id (整數或空值):選單路徑的 ID。

    • menu_path (字串):選單路徑名稱。

    • lang (字串):使用的語言。

    • barged (布林值):主管是否介入通話。

    • transfer (布林值):是否發生轉移。

    • transfer_id (整數或空值):轉移作業的 ID。

    • transfer_cold (布林值或空值):轉接是否為未知會第三方的冷轉接。

    • started_at (字串,日期時間):開始時間戳記。

    • ended_at (字串、日期時間或空值):結束時間戳記。

    • scheduled_at (字串、日期時間或空值):排定的時間戳記。

    • hold_duration (整數或空值):這個區段的保留時間長度。

    • assigned_connection_duration (整數):消費者在代理程式於這個階段連線時等待的時間長度。

    • session_breakthrough (物件;僅在通話突破專員的「無法接聽」狀態時顯示):通話突破專員「無法接聽」狀態的指派詳細資料 (如適用)。

佇列時間長度

  • queue_durations (陣列):物件陣列,每個物件代表通話的區隔,其中消費者處於佇列中。這有助於分析等待時間和服務水準。

    • id (整數):佇列時間的專屬 ID。

    • agent_id (整數):代理程式的 ID。

    • ended_at (字串,日期時間):結束時間戳記。

    • lang (字串):使用的語言。

    • menu_path_id (整數):選單路徑的 ID。

    • menu_path (字串):選單路徑名稱。

    • queue_duration (整數):佇列區段的時間長度。

    • started_at (字串,日期時間):開始時間戳記。

    • transfer_cold (布林值):通話是否已冷轉接。

    • transfer (布林值):是否發生轉移。

    • transfer_id (整數或空值):轉移作業的 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 (整數):專屬的升級 ID。

    • status (字串):目前狀態 (例如:升級、已升級或失敗)。

    • reason (字串):工作階段升級的原因。

    • created_at (字串,日期時間):開始升級的時間。

    • escalated_at (字串、日期時間或空值):升級完成的時間。

    • from_virtual_agent (物件或空值):轉接通話的虛擬代理。與「定義」中的 virtual_agent 物件形狀相同。

    • to_agent (物件或空值):通話轉接的真人服務專員。與「定義」中的 agent 物件形狀相同。

    • from_menu_path / to_menu_path (物件或空值):升級前後的選單路徑。

虛擬代理提報

  • virtual_agent_deflected_escalations (陣列):虛擬代理程式轉移的升級案件詳細資料。

    • id (整數):專屬 ID。

    • deflection (字串):偏轉類型。

    • escalation_id (整數):事件升級 ID。

    • escalation_reason (字串):呈報原因。

    • escalated_at (字串,日期時間):提升作業的時間戳記。

    • menu_path_id (整數):選單路徑 ID。

    • menu_path (字串):選單路徑。

    • lang (字串):語言。

    • virtual_agent (物件):虛擬代理詳細資料。請參閱「定義」。

虛擬代理處理時間

  • virtual_agent_handle_durations (陣列):虛擬服務專員處理通話的時間區段。

    • id (整數):專屬 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 (整數或空值):轉移事件 ID。

    • started_at (字串,日期時間):開始時間戳記。

    • ended_at (字串、日期時間或空值):結束時間戳記。

消費者處理時間

  • consumer_handle_durations (陣列):消費者通話的時間長度。

    • id (整數):專屬 ID。

    • call_duration (整數):消費者區隔時間長度。

    • hold_duration (整數或空值):消費者保留時間長度。

    • started_at (字串,日期時間):開始時間戳記。

    • ended_at (字串,日期時間):結束時間戳記。

消費者事件持續時間

  • consumer_event_durations (陣列):消費者通話事件的詳細資料 (例如 CSAT 或付款)。

    • id (整數):專屬 ID。

    • duration (整數):活動持續時間。

    • type (字串):事件類型。

    • event (字串):事件結果。

    • menu_path_id (整數):選單路徑 ID。

    • menu_path (字串):選單路徑。

    • lang (字串):語言。

    • started_at (字串,日期時間):開始時間戳記。

    • ended_at (字串,日期時間):結束時間戳記。

消費者在選單中停留的時間

  • consumer_in_menu_durations (陣列):消費者在選單中互動的時間長度。

    • id (整數):專屬 ID。

    • duration (整數):選單中的時間長度。

    • event (字串):選單互動結果。

    • menu_path_id (整數):選單路徑 ID。

    • menu_path (字串):選單路徑。

    • lang (字串):語言。

    • started_at (字串,日期時間):開始時間戳記。

    • ended_at (字串,日期時間):結束時間戳記。

參與者

  • participants (陣列):通話中每位參與者的相關資訊 (例如消費者、服務專員或虛擬服務專員)。

    • id (整數):參與者的專屬 ID。

    • type (字串):參與者類型 (「end_user」、「agent」、「virtual_agent」等)。

    • entry_type (字串):參與者加入通話的方式。

    • user_id (整數或空值):如果參與者是服務專員,則為使用者 ID。

    • end_user_id (整數或空值):如果參與者是消費者,則為消費者 ID。

    • virtual_agent_id (整數或空值):如果參與者是虛擬代理,則為虛擬代理 ID。

    • virtual_agent_params (物件;僅在設定虛擬代理程式自訂中繼資料以供納入時顯示):虛擬代理程式使用的自訂中繼資料。

    • status (字串):參與者的狀態 (「waiting」、「connected」、「finished」等)。

    • fail_reason (字串):失敗原因 (如有)。

    • connected_at (字串、日期時間或空值):參與者連線的時間戳記。

    • phone_number (字串;僅適用於消費者參與者):參與者的電話號碼。

    • call_id (整數):通話的 ID。

    • call_duration (整數或空值):參與者的通話時間長度。

    • hold_duration (整數或空值):參與者的保留時間長度。

    • ended_at (字串、日期時間或空值):參與者結束參與的時間戳記。

    • adapter_fail_code (整數或空值):對應失敗原因的數字代碼。

    • adapter_fail_message (字串或空值):fail_reason 的易讀說明 (如有)。

    • agent_assist (物件;只有在設定服務專員輔助時,才會顯示在服務專員參與者身上):這個參與者的服務專員輔助設定。

    • virtual_agent (物件;僅適用於虛擬代理程式參與者): 做為參與者的虛擬代理程式詳細資料,與頂層 agent_info 和 virtual_agent_params 不同。

    • caller_id (字串;僅在帳戶啟用 SIP 標頭來電顯示時顯示,且僅適用於消費者參與者):UJET 從這個消費者參與者的來電 SIP 標頭中擷取的來電顯示。

    • sip_headers (物件或空值):與這個出席者相關聯的 SIP 標頭。一律會出現在酬載中;如果 UJET 未擷取標頭,則為空值。

    • location (字串或空值;僅適用於代理程式參與者):代理程式的位置。

    • location_id (整數或空值;僅適用於代理參與者):地區 ID。

    • email (字串,電子郵件地址;僅適用於代理參與者):代理的電子郵件地址。

    • first_name (字串或空值;僅適用於代理商參與者):代理商的名字。

    • last_name (字串或空值;僅適用於服務專員參與者):服務專員的姓氏。

    • middle_name (字串或空值;僅適用於代理程式參與者):代理程式的中間名。

    • teams (陣列;僅適用於代理商參與者):代理商團隊的 { id, name } 物件陣列。

錄製內容

  • recordings (陣列):錄製通話音訊的相關資訊。

    • id (整數):錄音的專屬 ID。

    • call_id (整數):通話 ID。

    • conference_sid (字串或空值):VoIP 供應商的通話 ID。

    • duration (整數或空值):錄製時間長度。

    • recording_type (字串):錄音類型。

    • redaction_times (陣列):已遮蓋的時間區隔。

      • start (字串,日期時間):開始遮蓋的時間間隔。

      • end (字串,日期時間):遮蓋間隔結束的時間。

      • duration (整數):遮蓋時間長度 (以秒為單位)。

      • start_agent_id (整數或空值):啟動遮蓋作業的代理程式。

      • end_agent_id (整數或空值):結束遮蓋作業的代理人。

    • started_at (字串,日期時間):錄製開始時間戳記。

  • post_processed_recordings (陣列;僅在帳戶啟用後續處理錄音時顯示):後續處理產生的錄音 (例如格式轉換或編輯)。

    • id (整數):後製錄音內容的專屬 ID。

    • call_id (整數):通話 ID。

    • duration (整數):錄音時間長度,以秒為單位。

    • started_at (字串,日期時間):錄製開始時間戳記。

    • recording_file_name (字串):後製音訊資產的檔案名稱。

    • recording_url (字串,URI):後製音訊檔案的網址。

    • agent_id (整數或字串):與區隔相關聯的代理商 ID。

    • virtual_agent_id (整數或字串):與區隔相關聯的虛擬代理程式 ID (如有)。

    • conversation_id (字串):用於將這項錄音與對話記錄建立關聯的 ID。

  • segments (陣列;僅在帳戶啟用後續處理的洞察資料錄音時顯示):系統為下游洞察資料管道產生的每位參與者音訊 (和選用的螢幕錄影) 片段。

    • id (整數):區隔的專屬 ID。

    • call_id (整數):通話 ID。

    • duration (整數):區段時間長度,以秒為單位。

    • started_at (字串,日期時間):區隔開始時間戳記。

    • audio_file_name (字串):區段音訊資產的檔案名稱。

    • audio_url (字串,URI):區段音訊檔案的網址。

    • agent_id (整數或字串):與區隔相關聯的代理商 ID。

    • virtual_agent_id (整數或字串):與區隔相關聯的虛擬代理程式 ID (如有)。

    • participant_id (整數或字串):區隔所屬參與者的 ID。

    • conversation_id (字串):將這個區隔與對話記錄建立關聯的 ID。

    • screen_recording_url (字串、URI 或空值):相符螢幕錄製素材資源的網址。只有在帳戶中啟用螢幕錄影功能時,才會顯示這個選單。

    • screen_recording_file_name (字串或空值):螢幕錄影的檔案名稱。與 screen_recording_url 相同條件下提供。

提供活動

  • offer_type (字串或空值):UJET 如何將通話提供給服務專員。

  • offer_events (陣列):UJET 將通話轉接給服務專員時的事件。

    • casting_time (字串,日期時間):UJET 提供通話的時間。

    • group (字串):UJET 提供通話的群組。

其他詳細資料

  • answer_type (字串或空值):通話的解決方式 (「手動」或「自動」)。

  • outbound_number (字串或空值):使用的撥出電話號碼。

  • wait_time_sms (陣列;只有在通話期間發生等待時間簡訊互動時才會顯示):UJET 傳送給消費者的簡訊,內容為預計等待時間。每個項目都包含:

    • transfer_id (整數或空值):轉移事件 ID (如與轉移相關聯)。

    • status (字串):簡訊狀態。可能的值:not_triggered、triggered、triggered_allowed、triggered_denied、triggered_no_selection、triggered_sent、triggered_failed。

    • received (布林值):消費者是否收到簡訊。

  • in_call_sms (陣列;僅在通話期間發生簡訊互動時顯示):通話期間的簡訊互動。每個項目都包含:

    • transfer_id (整數或空值):轉移事件 ID (如與轉移相關聯)。

    • preset_sent (布林值):UJET 是否傳送預設訊息。

    • custom_sent (布林值):代理是否傳送自訂 (任意文字) 訊息。

    • received (布林值):UJET 是否收到消費者的簡訊。

  • dispositions (陣列;只有在帳戶啟用收尾代碼或附註時才會顯示):服務專員記錄的收尾代碼和附註。每個項目都包含根據收尾設定動態顯示的欄位:

    • user_id (整數):代理 ID。

    • transfer_id (整數或空值):轉移事件 ID (如有記錄)。

    • participant_id (整數):出席者 ID。

    • note (字串):任意文字的服務專員附註。

    • original_note (字串):記事的原始 (編輯前) 版本。

    • code (字串):處置代碼名稱。

    • ujet_code_id (整數或空字串):處置代碼的 UJET ID,是代碼的穩定鍵 (代碼顯示名稱可能會變更)。如果無法使用,則為空字串。

    • list (字串):程式碼所屬名單的名稱。

    • list_path (字串):以斜線分隔的程式碼清單路徑。

    • ujet_list_id (整數或空字串):處置代碼所屬清單的 UJET ID,也就是清單的穩定鍵。如果無法使用,則為空字串。

    • custom_list_id (字串或整數):如果已對應,則為顧客定義的名單 ID。

    • custom_code_id (字串或整數):如果已對應,則為客戶定義的代碼 ID。

  • email (字串、電子郵件或空值):消費者電子郵件地址。

  • feedback (字串或空值):消費者意見回饋。

  • smart_action_text (字串或空值):所採取任何智慧動作的文字。

  • custom_data_secured (物件或空值):自訂的安全簽署資料。

  • custom_data_not_secured (物件或空值):自訂、未安全簽署的資料。

  • in_queue_wait_time_va (陣列;只有在帳戶中為虛擬代理啟用佇列等待時間追蹤功能,且至少發生一次保留的虛擬代理轉接時才會顯示):消費者在佇列中等待的時間間隔,UJET 會在轉接後為消費者保留虛擬代理。每個項目都包含:

    • start (字串,日期時間):開始等待佇列的時間。

    • end (字串、日期時間或空值):佇列等待結束的時間;如果未完成,則為空值。

    • duration (整數或空值):等待時間長度 (以秒為單位);如果 end 為空值,則為空值。

  • auto_session_summaries (陣列;只有在帳戶啟用對話摘要功能,且 UJET 成功生成摘要時才會顯示):UJET 儲存至 CRM 記錄的 AI 生成工作階段摘要。每個項目都包含:

    • user_id (整數):與摘要相關聯的代理參與者 ID。

    • participant_id (整數):出席者 ID。

    • session_summary (字串):摘要文字。

    • session_summary_sections (陣列或物件):結構化區段中的摘要 (如有)。

  • sip_headers (物件;僅在帳戶啟用 SIP 標頭擷取功能,並設定將其納入工作階段中繼資料時顯示):UJET 為通話擷取的來電 SIP 標頭。鍵和值會反映從上游電話服務供應商收到的 SIP 標頭。

定義

本節會定義每個子結構定義一次。參照子結構定義的屬性群組會連結至這些定義,而不是重新定義其形狀。

說明通話所經過的階層式選單路徑。如需完整欄位清單,請參閱「選單導覽」。

參照來源:頂層 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_info 鑑別器 (請參閱「結構定義根目錄」) 的兩種變體之一。如需完整欄位清單,請參閱「服務專員和虛擬代理資訊」。

參照來源:真人服務專員最後處理通話時的 agent_info 欄位;每個 transfers[].from_agent 和 transfers[].to_agent;每個 escalations[].to_agent。

virtual_agent (物件)

說明虛擬代理。這個物件是頂層 agent_info 鑑別器 (請參閱「結構定義根目錄」) 的兩種變體之一。如需完整欄位清單,請參閱「服務專員和虛擬代理資訊」。

參照來源:虛擬代理上次處理通話時的 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 (string, enum)

通話或通話區段的轉接狀態。值會遵循 &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_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 使用兩種不同的詞彙,描述相同的基礎呼叫類型。UJET 會在每筆記錄中發出這兩個欄位,但兩者並非重複:

  • call_type 使用舊版列舉詞彙表。Voice Inbound (App) 和 Voice Inbound (IVR using App) 等值會涵蓋單一標籤下的所有行動裝置和應用程式內 SDK 來源。call_type 並未淘汰。UJET 會繼續發出這個欄位,但其詞彙不會獲得新的精細值。

  • session_type_v2 使用目前的列舉詞彙。這項功能會針對具有 v2 特定值的通話類型,導入更精細的來電區別,例如 Voice Inbound (Mobile) 和 Voice Inbound (IVR using Mobile)。如果通話類型沒有專屬的 v2 值,session_type_v2 會傳回與 call_type 相同的字串。

新的整合應剖析 session_type_v2。每個欄位的值都會列在「核心資訊」中。

等待時間欄位命名

通話工作階段中繼資料文件會在兩個範圍內回報佇列等待時間,並使用以下兩個欄位名稱:

  • 通話總時間:頂層 wait_duration 欄位會保存消費者在整個通話期間的等待總時間。

  • 每個區隔 - 頂層 queue_durations 陣列 (佇列時間長度) 中的每個項目都有自己的 queue_duration 欄位,其中包含該佇列區隔的佇列時間。

這兩個名稱都代表同一種評估指標 (在佇列中等待的時間),只是範圍不同。通話總時間 wait_duration 反映的是消費者整體佇列時間,而每個區隔的 queue_duration 值則說明每個佇列區隔。這份文件不會發出個別的頂層 queue_duration 欄位;每個區隔的值只會出現在 queue_durations 內。