本文說明即時通訊工作階段中繼資料記錄的結構定義。中繼資料記錄是 Contact Center AI 平台為支援聊天工作階段建立的 JSON 文件。CCAI Platform 會在即時通訊 session-end 指令中,將中繼資料記錄傳送至 CRM 整合服務。啟用外部儲存空間後,CCAI Platform 也會使用 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。
聊天室形狀鑑別器:chat_type、session_type、session_type_v2
(字串)
三個平行檢視畫面,顯示相同的基礎即時通訊類型。兩者在記錄代表的即時通訊類型上絕不會有歧異,只會使用不同的詞彙來命名。
chat_type:使用舊版列舉詞彙,例如「Messaging Inbound (App Chat)」、「Messaging (SMS)」和「Messaging (WhatsApp)」。session_type:一律傳回與chat_type相同的字串。這個欄位是為了與以這個欄位為鍵的整合項目向後相容而存在,請將其視為chat_type的已淘汰別名。session_type_v2:使用目前的列舉詞彙,可能包含更精細的區別,例如「訊息內送 (行動裝置即時通訊)」。如果即時通訊類型沒有專屬的 v2 值,session_type_v2會傳回與chat_type相同的字串。新的整合應剖析session_type_v2。
如要瞭解每個欄位的值,請參閱「核心資訊」。
核心資訊
id(整數):每個即時通訊工作階段的專屬 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(字串或空值):如果有的話,這是更具體的即時通訊狀態詳細資料。可能的值:"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(字串、日期時間或空值):CCAI Platform 將對話指派給專員的時間戳記,如果未指派,則為空值。ends_at(字串、日期時間或空值):聊天工作階段結束時的時間戳記。updated_at(字串,日期時間):CCAI 平台上次更新即時通訊資料的時間戳記。first_msg_sent_at(字串、日期時間或空值):參與者在對話中傳送第一則訊息時的時間戳記。last_msg_sent_at(字串、日期時間或空值):參與者在聊天室中傳送最後一則訊息時的時間戳記。wait_duration(整數):消費者等待的總時間 (以秒為單位)。chat_duration(整數):對話總時間長度,以秒為單位。verified(布林值):指出驗證智慧動作是否已驗證互動。rating(整數或空值):消費者提供的顧客滿意度 (CSAT) 評分,如果消費者未提供評分,則為空值。has_feedback(布林值):指出消費者是否在對話後提供意見回饋。out_ticket_id(字串或空值):CCAI Platform 在外部 CRM 系統中建立的案件 ID。out_ticket_url(字串、URI 或空值):CRM 服務單的網址。is_out_ticket_account(布林值或空值):指出 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(字串或空值):聊天室的供應商專屬管道 ID。message_count(整數):即時通訊中交換的訊息總數。average_response_time(整數):代理程式在即時通訊期間回覆的平均時間 (以秒為單位)。longest_response_time(整數):在即時通訊期間,專員回應的最長時間 (以秒為單位)。transcript(布林值):指出工作階段是否有對話轉錄稿。
服務專員和虛擬代理資訊
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(字串):選單類型 (例如"sms_menu"、"web_menu")。hidden(布林值):選單是否顯示或可供使用。menu_path(物件或空值):說明顧客瀏覽的選單階層路徑。items_count(整數):路徑中的選單數量。name(字串或空值):以斜線分隔的選單名稱字串 (例如"Support/Billing"),如果選單路徑無法使用,則為空值。materialized_path(字串):以斜線分隔的選單 ID 字串。
queue_priority_level(整數):指派給即時通訊所選佇列的佇列優先順序。Present only when queue priority is enabled on your account.
使用者詳細資料
end_user(物件或空值):消費者資訊:id(整數或空值):消費者的內部 ID。identifier(字串或空值):消費者的外部 ID。out_contact_id(字串或空值):消費者在 CRM 中的 ID。
客戶旗標和 SDK 提供的資料
customer_flag(物件):標記重要消費者屬性的旗標,這些屬性是由外部系統在工作階段期間提供或更新。只有在工作階段期間,外部系統提供或更新驗證相關的顧客標記時,才會顯示。verified_customer(布林值):指出外部系統是否將消費者標示為已驗證。bad_actor(布林值):指出外部系統是否將消費者標示為惡意行為人。repeat_customer(布林值):指出外部系統是否將消費者標示為回訪顧客。
custom_data_secured(物件或空值):SDK 或 Apps API 提供的自訂安全簽署資料。custom_data_not_secured(物件或空值):SDK 或 Apps API 提供的自訂非安全簽署資料。sip_headers(物件):為即時通訊擷取的傳入 SIP 標頭。鍵和值會反映從上游供應商收到的 SIP 標頭。只有在帳戶上啟用 SIP 標頭擷取功能,並將其設定為顯示在工作階段中繼資料中時,才會顯示
媒體附件
photos(陣列):與對話相關聯的相片或螢幕截圖。id(整數):相片的專屬 ID。photo_type(字串):相片類型。可能的值包括"photo"和"screenshot"。url(字串、URI):儲存相片的網址。smart_action_type(字串或空值):與相片相關聯的智慧動作 (如有)。transfer_id(整數或空值):與相片相關聯的轉移事件 ID (如果出席者在轉移完成後上傳相片)。
videos(陣列):與對話相關聯的影片。id(整數):影片的專屬 ID。url(字串、URI):儲存影片的網址。smart_action_type(字串或空值):與影片相關聯的智慧動作 (如有)。transfer_id(整數或空值):與影片相關聯的轉移事件 ID (如果參與者在轉移完成後上傳影片)。
轉移即時通訊
transfers(陣列):在對話期間,每個轉移事件各有一個項目。記錄代理、虛擬服務專員和選單之間的轉移。id(整數):轉移作業的專屬 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(字串、日期時間或空值):CCAI Platform 指派轉移作業的時間戳記。connected_at(字串、日期時間或空值):轉移連線時的時間戳記。updated_at(字串、日期時間或空值):CCAI Platform 上次更新轉移記錄的時間戳記。call_duration(整數或空值):轉移的即時通訊對話片段長度,以秒為單位。wait_duration(整數或空值):消費者在轉移期間等待的時間 (以秒為單位)。deflection(字串):與轉移作業相關聯的轉移類型。如要瞭解允許的值,請參閱「定義: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(整數):即時通訊工作時間長度,以秒為單位。chat_duration(整數):這個區段的即時通訊時間長度 (以秒為單位)。menu_path_id(整數或空值):選單路徑的 ID。menu_path(字串):選單路徑名稱。lang(字串):使用的語言。transfer(布林值):是否發生轉移。transfer_id(整數或空值):轉移作業的 ID。started_at(字串、日期時間或空值):開始時間戳記。ended_at(字串、日期時間或空值):結束時間戳記。response_count(整數):代理程式回覆次數。response_time_total(整數):代理程式總回應時間 (以秒為單位)。response_time_max(整數):最長客服專員回覆時間,以秒為單位。response_time_avg(數字或空值):代理程式的平均回應時間 (以秒為單位)。這個值可能包含小數精度。assigned_connection_duration(整數):在這段期間,指派的服務專員連線時,消費者等待的時間長度。
佇列時間長度
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(字串):對話呈報原因。可能的值:"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(字串、日期時間或空值):升級完成的時間戳記。from_virtual_agent(物件或空值):升級對話的虛擬代理。與「定義」中的virtual_agent物件形狀相同。from_menu_path/to_menu_path(物件或空值):升級前後的選單路徑。
虛擬代理避免提報
virtual_agent_deflected_escalations(陣列):虛擬代理程式將通話轉送至其他目的地時,升級的詳細資料。id(整數):專屬 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(整數):事件升級 ID。escalation_reason(字串):呈報原因。與escalations[].reason相同 (請參閱第 10 節虛擬服務專員轉接給真人服務專員)。escalated_at(字串,日期時間):提升作業的時間戳記。menu_path_id(整數):選單路徑 ID。menu_path(字串):選單路徑。lang(字串):語言。virtual_agent(物件):虛擬代理詳細資料。請參閱「定義:virtual_agent」。
虛擬代理處理時間
virtual_agent_handle_durations(陣列):虛擬服務專員處理即時通訊的時間區段。id(整數):專屬 ID。virtual_agent(物件):虛擬代理詳細資料。請參閱「定義:virtual_agent」。chat_duration(整數):區段時間長度,以秒為單位。escalation_reason(字串):呈報原因。finish_reason(字串):互動結束的原因。response_count(整數):虛擬代理回覆次數。response_time_total(整數):虛擬代理回應的總時間 (以秒為單位)。response_time_max(整數):虛擬代理最長的回應時間 (以秒為單位)。response_time_avg(數字或空值):虛擬代理的平均回應時間 (以秒為單位)。這個值可能包含小數精度。fallback_response_count(整數):備用回應數。initiated_by(字串):虛擬代理程式工作階段的啟動方式。 可能的值:"end_user"、"human_agent"和"post_session"。menu_path_id(整數):選單路徑 ID。menu_path(字串):選單路徑。lang(字串):語言。transfer(布林值):即時通訊是否已轉移。transfer_id(整數或空值):轉移事件 ID。started_at(字串,日期時間):開始時間戳記。ended_at(字串,日期時間):結束時間戳記。
消費者處理時間
consumer_handle_durations(陣列):消費者在對話中的時間長度。id(整數):專屬 ID。chat_duration(整數):消費者區隔時間長度 (以秒為單位)。started_at(字串、日期時間或空值):開始時間戳記。ended_at(字串、日期時間或空值):結束時間戳記。message_count(整數):消費者訊息數。response_count(整數):消費者回應數。response_time_total(整數):消費者回應時間總計 (以秒為單位)。response_time_max(整數):最長消費者回應時間 (以秒為單位)。response_time_avg(整數):消費者的平均回應時間 (以秒為單位)。
消費者事件持續時間
consumer_event_durations(陣列):消費者即時通訊事件的詳細資料 (例如顧客滿意度:CSAT、付款)。id(整數):專屬 ID。duration(整數):事件時間長度,以秒為單位。type(字串):事件類型。可能的值包括:"csat"。event(字串):事件結果。可能的值:"finished"和"abandoned"。menu_path_id(整數):選單路徑 ID。menu_path(字串):選單路徑。lang(字串):語言。started_at(字串,日期時間):開始時間戳記。ended_at(字串,日期時間):結束時間戳記。
參與者
participants(陣列):聊天室中每位參與者的資訊 (例如使用者、服務專員、虛擬服務專員)。id(整數):參與者的專屬 ID。type(字串):出席者類型。可能的值:"end_user"、"agent"、"manager"、"virtual_agent"、"external_agent"和"task_virtual_agent"。entry_type(字串):參與者進入即時通訊的方式。可能的值:"queue_or_transfer"、"barge"和"post_session"。user_id(整數或空值):如果參與者是服務專員,則為使用者 ID。end_user_id(整數或空值):消費者 ID (如果參與者是消費者)。virtual_agent_id(整數或空值):如果參與者是虛擬代理,則為虛擬代理 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(字串、日期時間或空值):參與者連線的時間戳記。phone_number(字串):參與者的電話號碼。僅向消費者參與者顯示。chat_id(整數):即時通訊的 ID。chat_duration(整數或空值):參與者的即時通訊時間長度 (以秒為單位)。finished_at(字串、日期時間或空值):參與者結束參與的時間戳記。agent_assist(物件):為參與者啟用的 Agent Assist 設定。一律會顯示;如果未設定 Agent Assist,則為空白預設物件。virtual_agent(物件或空值):做為這個出席者的虛擬代理詳細資料;與頂層agent_info和virtual_agent_params不同。sip_headers(物件或空值):與這個出席者相關聯的 SIP 標頭。一律會出現在酬載中;如果 CCAI Platform 未擷取任何內容,則為空值。location(字串或空值):代理程式的設定位置。只向代理商參與者顯示。location_id(整數或空值):地點的 ID。僅向代理參與者簡報。email(字串,電子郵件):代理的電子郵件地址。僅向代理參與者簡報。first_name(字串或空值):代理商的名字。僅向代理參與者簡報。last_name(字串或空值):代理人的姓氏。僅向代理參與者簡報。middle_name(字串或空值):代理人的中間名。僅向代理參與者簡報。teams(陣列):{ id, name }物件的陣列,說明代理程式所屬的團隊。僅適用於代理商參與者。
報到記錄
check_in_logs(陣列):在對話期間記錄的簽到事件。 每個項目都會將一個入住流程的入住事件歸為一組。check_in_id(整數):入住流程的 ID。check_in_modal_displayed(字串,日期時間):CCAI 平台向消費者顯示入住確認對話方塊的時間戳記。Present only when CCAI Platform displayed the check-in modal.check_in_modal_confirmed(字串,日期時間):消費者確認自己仍在現場時的時間戳記。只有在消費者確認入住模式時才會顯示。check_in_modal_timed_out(字串,日期時間):簽到提示逾時的時間戳記。Present only when the 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(字串或空值):CCAI Platform 將即時通訊提供給服務專員的方式。offer_events(陣列):CCAI 平台將即時通訊轉交給服務專員的事件。casting_time(字串,日期時間):CCAI 平台提供即時通訊的時間。group(字串):CCAI 平台提供對話的群組。
其他詳細資料
dismiss_duration(整數):聊天處於已關閉狀態的時間長度 (以秒為單位)。Present only when the chat spent time in the dismissed status.answer_type(字串或空值):回覆即時通訊的方式。可能的值:"manual"、"auto"、"outbound"和"deflection"。inbound_number(字串):與對話相關聯的來電號碼。 Present only when an inbound phone number is associated with the chat.outbound_number(字串):與對話相關聯的外撥電話號碼。 Present only when an outbound phone number is associated with the chat. (用來存放外撥電話號碼的容器,只有在有與即時通訊相關聯的外撥電話號碼時才存在。)after_hours(布林值):即時通訊是否在非營業時間進行。dispositions(陣列):服務專員記錄的收尾代碼和附註。只有在帳戶中啟用收尾代碼或附註時才會顯示。每個項目可能包含根據您的收尾設定有條件顯示的欄位:user_id(整數):代理 ID。transfer_id(整數或空值):轉移事件 ID (如有記錄)。participant_id(整數):出席者 ID。note(字串):任意文字的服務專員附註。original_note(字串):記事的原始 (編輯前) 版本。code(字串):處置代碼名稱。ujet_code_id(整數或空字串):CCAI Platform 指派的處置代碼 ID;代碼的穩定鍵 (代碼顯示名稱可能會變更)。如果無法使用,則為空字串。list(字串):程式碼所屬名單的名稱。list_path(字串):以斜線分隔的程式碼清單路徑。ujet_list_id(整數或空字串):CCAI Platform 指派給處置代碼所屬清單的 ID;清單的穩定鍵。如果無法使用,則為空字串。custom_list_id(字串或整數):如果已對應,則為顧客定義的名單 ID。custom_code_id(字串或整數):如果已對應,則為客戶定義的代碼 ID。
auto_session_summaries(陣列):AI 生成的工作階段摘要,會儲存至 CRM 記錄。只有在帳戶啟用對話摘要功能,且 AI 成功生成摘要時,才會顯示這個容器。每個項目都包含:user_id(整數):與摘要相關聯的代理參與者 ID。participant_id(整數):出席者 ID。session_summary(字串):摘要文字。session_summary_sections(陣列或物件):摘要會分成結構化區塊 (如有)。
transfer_limit(物件或空值):即時通訊的轉移限制資料。enabled(布林值):聊天室是否已啟用轉移限制追蹤功能。limit_count(整數):允許的轉移次數。limit_reached(布林值):對話是否達到設定的轉移上限。
email(字串、電子郵件或空值):消費者的電子郵件地址。feedback(字串或空值):消費者意見回饋。smart_action_text(字串或空值):所採取任何智慧動作的文字。
定義
下列子結構定義會出現在聊天工作階段中繼資料文件的多個位置。每個子結構定義只會出現一次。參照這些屬性的屬性群組會指向這個區段,而不是重新定義其形狀。
menu_path (物件)
說明即時通訊經過的階層式選單路徑。如需完整欄位清單,請參閱「選單導覽」。
參照來源:頂層 menu_path 欄位;每個 transfers[].from_menu_path 和 transfers[].to_menu_path;每個 escalations[].from_menu_path 和 escalations[].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;每個 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 (物件)
Describes a transfer that occurred during the chat. 轉移作業可將即時通訊從選單、服務專員和虛擬服務專員之間轉移。如需完整欄位清單,請參閱「對話轉移」。
參照來源:頂層 transfers 陣列。(文件中其他名為 transfer_id 的欄位都是對轉移作業 id 的整數參照,而非內嵌的 transfer 物件)。
participant (物件)
描述即時通訊中的一位參與者。參與者形狀會因參與者類型而異;服務專員參與者可包含服務專員個人資料、位置、團隊和 Agent Assist 欄位,而消費者和虛擬服務專員參與者則包含類型專屬的 ID。如需完整的文件欄位清單,請參閱「參與者」。
參照來源:頂層 participants 陣列;
auto_session_summaries[].participant_id;處置記錄。
時間長度列 (物件)
說明即時通訊中的測量間隔,例如服務專員處理時間、佇列時間、消費者處理時間、消費者事件時間或虛擬服務專員處理時間。每個時間長度陣列都有自己的列形狀,因為名稱相似的欄位在不同資料表之間可能會有不同的精確度或可為空值。
參考來源: 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 描述的是相同的基礎即時通訊類型,但使用兩種不同的詞彙。CCAI 平台會在每筆記錄中發出這兩個欄位,兩者並非重複資料:
chat_type使用舊版列舉詞彙表。「訊息傳入 (應用程式即時通訊)」和「訊息傳入 (簡訊)」等值會說明原始的即時通訊類型類別。session_type_v2使用目前的列舉詞彙。如果聊天類型有專屬的 v2 值,這項異動可能會導入更精細的區別。如果即時通訊類型沒有專屬的 v2 值,session_type_v2會傳回與chat_type相同的字串。
新的整合應剖析 session_type_v2。每個欄位的值都會列在「核心資訊」中。
加總欄位
隨著時間推移,聊天工作階段中繼資料酬載可能會新增頂層欄位、巢狀欄位、陣列項目欄位或列舉值。整合功能應忽略無法辨識的鍵,並盡可能保留原始記錄。避免嚴格剖析,以免出現新屬性時剖析失敗。