通話工作階段中繼資料

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

結構定義根層級

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

主鍵 — 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 鍵:通話中沒有真人服務專員或虛擬服務專員,以及兩者都有。如果虛擬服務專員在轉接給真人服務專員後仍保留,則通話會同時包含這兩者,因此完全處理的通話可能會在沒有索引鍵的情況下到達。

如要偵測記錄攜帶的變體,請先檢查 agent_info 鍵是否存在,然後檢查變體專屬欄位,通常是真人服務專員變體的 agent_info.email,或虛擬服務專員變體的 agent_info.va_alias。請勿僅根據 agent_info 推斷處理者;如果通話同時涉及兩者,請從 participants[] 讀取服務專員,並從 virtual_agent_handle_durations[] 或 transfers[] 和 escalations[] 上的 from_virtual_agent 和 to_virtual_agent 欄位讀取虛擬服務專員。如要查看各個變體的完整形狀,請參閱 agent 和 virtual_agent。

呼叫形狀區別符:call_type、session_type、session_type_v2 (字串)

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

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

  • session_type 一律會傳回與 call_type 相同的字串。CCAI 平台提供這個欄位,是為了與以這個欄位為索引鍵的整合功能回溯相容;請將這個欄位視為 call_type 的已淘汰別名。請參閱「版本管理和淘汰」。

  • session_type_v2 使用目前的列舉詞彙。這個詞彙集擴充了 call_type 詞彙集,提供更精細的入站區別,例如以 Voice Inbound (Mobile) 和 Voice Inbound (IVR via Mobile) 取代更廣泛的 Voice Inbound (App) 和 Voice Inbound (IVR via App)。如果呼叫類型沒有 v2 專屬值,session_type_v2 會傳回與 call_type 相同的字串。新的整合功能應剖析 session_type_v2。

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

核心資訊

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

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

  • call_uuid (字串或空值):專屬 ID,用於在動態通話轉接 (DCR) 互動中,建立來源和接收執行個體之間的通話關聯。DCR 呼叫的兩個部分會共用相同的 call_uuid 值,讓客戶在環境之間橋接資料。如果通話並非 DCR 互動,或是在 CCAI 平台新增該欄位前發生,則該欄位為空值或空白。

  • lang (字串):通話的 ISO 639 語言代碼 (例如「en」代表英文,「es」代表西班牙文)。這個代碼可協助您執行特定語言的分析和報表。

  • call_type (字串):呼叫類型,使用舊版類型詞彙。值包括「Voice Inbound (App)」、「Voice Inbound (Web)」、「Voice Inbound (IVR)」、「Voice Inbound (IVR via App)」、「Voice Inbound (API)」、「Voice Inbound (Direct)」、「Voice Inbound (Extension)」、「Voice Scheduled (App)」、「Voice Scheduled (Web)」、「Voice Scheduled (API)」、「Voice Callback」、「Voice Callback (Web)」、「Voice Outbound」、「Voice Outbound (API)」、「Voice Outbound (Direct)」、「Voice Outbound (UCaaS)」、「Voice Internal」、「Voice Campaign (Acqueon)」、「Voice Campaign (<您的品牌名稱>)」和「Agent Scheduled Call」。

  • session_type (字串):call_type 的副本 (值相同),CCAI 平台會保留此副本,以確保回溯相容性。請參閱「版本管理和淘汰:舊版重複項目」。

  • session_type_v2 (字串):通話類型,使用目前的類型詞彙。這項功能會以更精細的來電區別方式,修正 call_type 值 (例如,以「Voice Inbound (Mobile)」和「Voice Inbound (IVR via Mobile)」取代「Voice Inbound (App)」和「Voice Inbound (IVR via App)」)。值包括「Voice Inbound (Mobile)」、「Voice Inbound (Web)」、「Voice Inbound (IVR)」、「Voice Inbound (IVR via Mobile)」、「Voice Inbound (API)」、「Voice Inbound (Direct)」、「Voice Inbound (Extension)」、「Voice Scheduled (Mobile)」、「Voice Scheduled (Web)」、「Voice Scheduled (API)」、「Voice Callback」、「Voice Callback (Web)」、「Voice Outbound」、「Voice Outbound (API)」、「Voice Outbound (Direct)」、「Voice Outbound (UCaaS)」、「Voice Internal」、「Voice Campaign (Acqueon)」、「Voice Campaign (<您的品牌名稱>)」和「Agent Scheduled Call」。

  • status (字串):通話狀態,追蹤通話生命週期的進度。可能的值 (依生命週期階段分組):

    • 預先連線:"scheduled"、"selecting"、"queued"、"assigned"、"connecting"、"switching"、"requeued"、"requeued_detection_missed"。

    • 已連結:"connected"。

    • 虛擬服務專員:"va_assigned"、"va_connected"。

    • 廣告活動:"preview_pending"、"preview_ready"、"preview_waiting"、"predictive_waiting"、"progressive_waiting"、"campaign_dialing"、"campaign_connecting"、"campaign_connected"。

    • 僅限動作:"action_only"、"action_only_finished"。

    • 語音留言:"voicemail"、"voicemail_received"、"voicemail_read"、"voicemail_forwarded"。

    • 終端機:"finished"、"failed"、"recovered"、"deflected"。

  • created_at (字串,日期時間):CCAI 平台建立通話記錄的精確時間戳記。

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

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

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

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

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

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

  • wait_duration (整數或空值):消費者在整通電話中花費的總排隊時間 (以秒為單位),如果 CCAI Platform 未記錄任何排隊時間,則為空值。如要查看依個別區隔細分的佇列時間,請參閱 queue_durations 陣列 (佇列時間長度)。請參閱「版本管理和淘汰:等待時間欄位命名法」。

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

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

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

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

  • voip_provider (字串):通話的 VoIP 供應商。(註:此欄位已棄用,並始終傳回「已棄用」。)

  • out_ticket_id (字串或空值):CCAI 平台在外部 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"。可能的值:"not_voicemail"、"temporary_redirection"、"after_hour_deflection"、"over_capacity_deflection"、"no_input" 和 "no_agent"。

  • 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、transfer_expired、canceled_outside_fulfillment_hours

    • 使用者:eu_canceled、eu_rejected、eu_abandoned、eu_in_menu_abandoned、eu_repeated_voicemail、eu_repeated_callback、eu_dcr_abandoned_on_receiving、eu_busy、eu_wrong_number、eu_no_answer、eu_noti_failed、eu_phone_denied

    • 代理:ag_canceled、ag_ignored、ag_declined、ag_mic_no_device、ag_mic_denied、ag_invalid_outbound_num、ag_called_blocked_num

    • 連線:conn_decline

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

    • 音訊:audio_not_received_by_carrier、audio_device_unable_to_start

    • 卡住或無法解決的狀態:stuck_due_to_api_error、group_deleted_no_substitute、menu_deleted、direct_pstn_call_to_fallback_number

    • 廣告活動:campaign_paused、campaign_queue_reassigned、campaign_no_incoming_contacts、campaign_call_canceled

    • 強制結束:force_ended、force_failed_call_stuck

  • fail_details (字串或空值):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 (字串):以斜線分隔的選單名稱字串 (例如「支援/帳單」)。

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

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

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

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

      • group_label (字串):重新導向群組的人類可讀標籤 (例如「Redirection Group 1」)。

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

      • after_hours (布林值或空值):是否為群組啟用非營業時間轉接選項。

      • ah_destination (物件或空值):您在群組中設定的非營業時間重新導向目的地。

使用者詳細資料

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

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

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

    • out_contact_id (字串或空值):消費者在客戶關係管理系統中的 ID。

自訂和 SDK 提供的資料

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

  • api_dap_request (物件;只有在啟用資料參數並將其納入中繼資料時才會顯示):呼叫資料參數值的快照。鍵和值類型取決於資料參數設定。

  • 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 (陣列):提供通話期間轉移的詳細記錄。每個項目的偏轉欄位都會使用「定義:偏轉」中定義的列舉。每個項目都包含:

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

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

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

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

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

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

    • to_menu_path (物件或空值):CCAI 平台轉移通話的選單路徑。

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

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

移轉

  • transfers (陣列):通話期間,每個轉接事件都會有一筆記錄。記錄代理、虛擬代理和選單之間的熱轉接和冷轉接。

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

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

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

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

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

    • connected_at (字串、日期時間或空值):轉接連線的時間。

    • updated_at (字串,日期時間):CCAI 平台上次更新轉移記錄的時間。

    • 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 (物件或空值):轉移作業兩端的虛擬服務專員;形狀與「Definitions」中的 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 (字串):提報案件的目前狀態。可能的值:escalating、"escalated"、"canceled"、"deflecting" 和 "deflected"。

    • 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 (字串):記錄已轉移提報案件的轉移類型。這個詞彙集比「定義:轉移」一節所述的通話層級轉移欄位小,僅涵蓋虛擬服務專員提報可記錄的結果。可能的值:

      • 超載:over_cap、over_cap_phone、over_cap_voicemail、over_cap_callback、over_cap_message、over_cap_queue、over_cap_sip、over_cap_extension、over_cap_phone_with_extension

      • 非營業時間:after_hours、after_hours_phone、after_hours_voicemail、after_hours_message、after_hours_message_only、after_hours_queue、after_hours_sip、after_hours_extension、after_hours_phone_with_extension

      • 暫時重新導向:temp_redirection、temp_redirection_phone、temp_redirection_voicemail、temp_redirection_message、temp_redirection_queue、temp_redirection_sip、temp_redirection_extension、temp_redirection_phone_with_extension

      • IVR 預先工作階段:ivr_presession_deflection

      • 虛擬服務專員發起:va_redirection_phone、va_redirection_sip、va_third_party_phone、va_third_party_sip

      如果通話在達到轉移結果前結束,系統會記錄不含後置字串的 over_cap、after_hours 和 temp_redirection 值。

    • escalation_id (整數):提報事件 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 (陣列):消費者通話事件的詳細資料 (例如顧客滿意度或付款)。

    • 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 (物件;只有在設定 Agent Assist 時,才會出現在代理參與者上):這位參與者的有效 Agent Assist 設定。

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

    • caller_id (字串;只有在帳戶啟用 SIP 標頭來電顯示,且僅限消費者參與者時才會顯示):CCAI 平台從這個消費者參與者的傳入 SIP 標頭中擷取的來電顯示。

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

    • 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 (字串或空值):CCAI 平台向服務專員提供通話的方式。

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

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

    • group (字串):CCAI 平台提供通話的群組。

其他詳細資料

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

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

  • wait_time_sms (陣列;僅在本次通話發生等待時間簡訊互動時顯示):CCAI 平台傳送給消費者的簡訊互動,內容為預計等待時間。每個項目都包含:

    • 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 (布林值):CCAI 平台是否傳送預設訊息。

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

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

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

    • user_id (整數):代理 ID。

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

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

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

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

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

    • ujet_code_id (整數或空白字串):處理代碼的 CCAI 平台 ID,也就是代碼的穩定鍵 (代碼顯示名稱可以變更)。如果無法使用,則為空白字串。

    • list (字串):代碼所屬清單的名稱。

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

    • ujet_list_id (整數或空白字串):處理代碼所屬清單的 CCAI 平台 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 (陣列;只有在帳戶中啟用虛擬服務專員的佇列等待時間追蹤功能,且至少發生一次保留虛擬服務專員提報時,才會顯示):消費者在佇列中等待的時間間隔,此時 CCAI Platform 在提報後為他們保留虛擬服務專員。每個項目都包含:

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

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

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

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

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

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

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

    • session_summary_sections (陣列或物件):結構化章節的摘要 (如有)。

  • sip_headers (物件;只有在帳戶啟用 SIP 標頭擷取功能,並設定納入工作階段中繼資料時,才會顯示):CCAI Platform 為通話擷取的傳入 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 (物件)

說明真人服務專員。這個物件是頂層 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_ewt_only、over_cap_sip、over_cap_extension、over_cap_phone_with_extension。

  • 放棄轉移:轉移或通話在待處理轉移解決前結束:deflection_abandoned。

  • 非營業時間:來電時間不在選單設定的營業時間內:after_hours_voicemail、after_hours_phone、after_hours_message_only、after_hours_queue、after_hours_message、after_hours_sip、after_hours_extension、after_hours_phone_with_extension。

  • 暫時重新導向:在選單中設定暫時重新導向:temp_redirection_phone、temp_redirection_message、temp_redirection_voicemail、temp_redirection_queue、temp_redirection_sip、temp_redirection_extension、temp_redirection_phone_with_extension。

  • IVR 預先工作階段:ivr_presession_deflection。

  • 虛擬服務專員發起:虛擬服務專員重新導向或轉接通話時:va_redirection_phone、va_redirection_sip、va_third_party_phone、va_third_party_sip。

  • 非上班時間內部通話:internal_call_after_hours_message、internal_call_after_hours_queue、internal_call_after_hours_phone、internal_call_after_hours_extension、internal_call_after_hours_sip、internal_call_after_hours_voicemail。

  • 內部通話超額:internal_call_over_capacity_message、internal_call_over_capacity_queue、internal_call_over_capacity_phone、internal_call_over_capacity_extension、internal_call_over_capacity_sip、internal_call_over_capacity_voicemail、internal_call_over_capacity_wait。

  • 內部呼叫自動重新導向:internal_call_automatic_redirection_message、internal_call_automatic_redirection_queue、internal_call_automatic_redirection_phone、internal_call_automatic_redirection_extension、internal_call_automatic_redirection_sip、internal_call_automatic_redirection_voicemail。

  • 非營業時間轉接電話:call_transfer_after_hours_message、call_transfer_after_hours_queue、call_transfer_after_hours_phone、call_transfer_after_hours_extension、call_transfer_after_hours_sip、call_transfer_after_hours_voicemail。

  • 來電轉接超載:call_transfer_over_capacity_message、call_transfer_over_capacity_queue、call_transfer_over_capacity_phone、call_transfer_over_capacity_extension、call_transfer_over_capacity_sip、call_transfer_over_capacity_voicemail、call_transfer_over_capacity_wait。

  • 來電轉接自動重新導向:call_transfer_automatic_redirection_message、call_transfer_automatic_redirection_queue、call_transfer_automatic_redirection_phone、call_transfer_automatic_redirection_extension、call_transfer_automatic_redirection_sip、call_transfer_automatic_redirection_voicemail。

  • 緊急關機:管理員觸發緊急關機時:emergency_shutdown、emergency_shutdown_message、emergency_shutdown_after_hours、emergency_shutdown_over_capacity。

  • 動態來電轉接 (DCR):dcr_transferred、dcr_missed、dcr_redirected、dcr_finished。

參照來源:每個完整使用這個詞彙的 deflection_details[].deflection。另外兩個欄位則分別使用其中一部分:

  • 頂層 deflection 欄位會使用 over_cap_ewt_only 和 temp_redirection_url 以外的所有值。

  • 每個 transfers[].deflection 都會使用較小的轉移範圍子集:no_deflection、deflecting、deflection_abandoned、十個 over_cap_* 值、八個 after_hours_* 值、temp_redirection_url 以外的七個 temp_redirection_* 值、ivr_presession_deflection、va_redirection_phone 和 va_redirection_sip。internal_call_*、call_transfer_*、emergency_shutdown_*、dcr_* 和 va_third_party_* 系列絕不會出現在轉移作業中。

版本管理與淘汰

通話工作階段中繼資料結構定義支援回溯相容演進。CCAI 平台隨時可能新增欄位和陣列。整合功能應忽略無法辨識的金鑰,確保功能持續運作。本節中的欄位已淘汰、過時或軟取代。為了回溯相容性,這些欄位仍會保留在酬載中,但新的整合必須遵循各欄位的指南。

已淘汰的欄位

  • voip_provider (字串) - 已淘汰。一律傳回字面字串「deprecated」。CCAI 平台不會再透過這份文件,向整合項目顯示供應商資訊。沒有替代欄位;如果整合需要識別上游電話服務供應商,請與帳戶團隊聯絡。

舊版重複項目

  • session_type (字串) - call_type 的舊版別名。一律傳回與 call_type 相同的值,並使用相同的舊版列舉詞彙。CCAI 平台會保留這個欄位,以便與以 session_type 為索引鍵的整合功能回溯相容。新的整合項目應直接剖析 call_type,或剖析 session_type_v2 (如需更精細的傳入區別,請參閱下方的「詞彙演變」)。

詞彙演變

call_type 和 session_type_v2 使用兩種不同的詞彙描述相同的基礎呼叫類型。CCAI 平台會為每筆記錄發出這兩個欄位,兩者並非重複:

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

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

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

等待時間欄位命名法

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

  • 通話總計:頂層 wait_duration 欄位會保留消費者在整通通話中,在佇列中花費的總時間。

  • 每個區段:頂層 queue_durations 陣列 (佇列時間長度) 中的每個項目都有自己的 queue_duration 欄位,用於保存該佇列區段的佇列時間。

這兩個名稱都是指同一種評估指標 (在佇列中花費的時間),但範圍不同。通話總計 wait_duration 反映 消費者的整體等候時間,而每個區隔的 queue_duration 值 則描述每個等候區隔。這份文件不會發出獨立的頂層 queue_duration 欄位,每個區隔的值僅適用於 queue_durations 內部。