通話工作階段中繼資料

本文說明用於建構通話工作階段中繼資料的 JSON 結構定義。這個結構定義對於準確呈現及處理通話工作階段至關重要。

通話工作階段中繼資料結構定義

這個結構定義描述與通話工作階段中繼資料相關的資料結構。以下各節將說明主要元件。

核心資訊

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

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

• lang (字串)。通話期間使用的 ISO 689 語言代碼，例如 en 代表英文，es 代表西班牙文。這對於特定語言的分析和報表至關重要。

• call_type (字串)。通話類型，使用舊版類型集。例如語音來電 (應用程式)、語音外撥和語音內部通話。這有助於根據通話來源和目的分類。

• session_type (字串)：call_type 的副本

• session_type_v2 (字串)。呼叫類型，使用目前的類型集。 這與 call_type 類似，但可能包含更細微的區別，例如「Voice Inbound (Mobile)」或「Voice Inbound (IVR using Mobile)」。

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

• subStatus(字串)。提供更詳細的通話狀態。可能的值包括 waiting_for_agent、in_queue 和 connected_with_agent。

• created_at (字串，日期時間)：建立通話記錄的確切時間戳記

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

• assigned_at (字串、日期時間或空值)：通話指派給服務專員的時間戳記，如果未指派，則為空值

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

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

• scheduled_at (字串、日期時間或空值)：通話排定的時間戳記，如果是立即通話，則為空值

• updated_at (字串，日期時間)：上次修改通話資料的時間戳記

• wait_duration (整數)：顧客的總等待時間 (以秒為單位)

• call_duration (整數)：通話總時間長度 (以秒為單位)

• hold_duration (整數)：客戶等待接聽的總時間 (以秒為單位)，如果沒有等待時間，則為空值

• rating (整數或空值)：顧客提供的顧客滿意度 (CSAT) 評分，如果顧客未提供評分，則為空值

• has_feedback (布林值)：表示顧客是否在通話後提供意見回饋的標記

• voip_provider (字串)：用於通話的 VoIP 供應商。這個欄位已淘汰，一律會傳回 deprecated。

• out_ticket_id (字串)：在外部 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。

服務專員和虛擬服務專員資訊

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

• agent_info (物件)。這個欄位可保留真人或虛擬服務專員的相關資訊。並使用 one of 關鍵字指定可為兩種型別之一。

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

    • id (整數)：代理的 ID

    • agent_number (字串或空值)：指派給代理的 ID

    • email (字串，電子郵件)：代理的電子郵件地址

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

    • last_name (字串)：代理的姓氏

    • first_name (字串)：代理人的名字

    • avatar_url (字串，URI)：代理程式顯示圖片的網址

  • virtual_agent (物件)：虛擬服務專員的相關資訊：

    • id (整數)：虛擬服務專員的 ID

    • name (字串)：虛擬代理的名稱

    • avatar_url (字串，URI)：虛擬代理人顯示圖片的網址

瀏覽選單

• selected_menu (物件或空值)：顧客在通話期間選取的菜單相關資訊

  • id (整數)：選單 ID

  • name (字串)：選單名稱

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

  • position (整數)：相對於同一層級其他選單的選單位置

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

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

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

• menu_path (物件或空值)：說明顧客瀏覽的選單階層路徑

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

  • name (字串)：以斜線分隔的選單名稱字串。例如 dupport 或 billing。

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

使用者詳細資料

• end_user (物件)：顧客相關資訊

  • id (整數)：客戶的內部 ID

  • identifier (字串或空值)：顧客的外部 ID

  • out_contact_id (字串或空值)：客戶在 CRM 中的 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 (物件或空值)：呼叫遭到轉移的選單路徑

  • to_sip_uri (字串或空值)：通話轉接的 SIP URI (如適用)

  • to_sip_headers (物件)：通話轉接時使用的 SIP 標頭 (如適用)

通話處理時間長度

• 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 (整數)：服務等級合規性的目標時間

虛擬服務專員轉接

• 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 (陣列)：終端使用者通話事件的詳細資料。例如客戶滿意度或付款。

  • 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 (字串)：參與者的狀態。例如「等待」、「已連線」、「已完成」等。

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

  • connected_at (字串，日期時間)：參與者連線時的時間戳記

  • phone_number (字串)：參與者的電話號碼

  • call_id (整數)：通話的 ID

  • call_duration (整數)：參與者的通話時間長度

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

  • ended_at (字串，日期時間)：參與者結束參與的時間戳記

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

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

錄製內容

• recordings (陣列)：通話錄音資訊

  • id (整數)：錄製內容的 ID

  • call_id (整數)：通話 ID

  • conference_sid (字串)：VoIP 供應商的通話 ID

  • duration (整數)：錄製時間長度

  • recording_type (字串)：錄音類型

  • redaction_times (陣列)：已編輯的時間區隔

  • started_at (字串，日期時間)：錄製開始時間戳記

提供活動

• offer_type (字串或空值)：提供給服務專員的通話方式

• offer_events (陣列)：向服務專員提供通話的事件

  • casting_time (日期時間)：提供通話的時間

  • group (字串)：提供通話的群組

其他詳細資料

• answer_type (字串或空值)：接聽電話的方式。例如手排或自排。

• outbound_number (字串)：使用的外撥電話號碼

• wait_time_sms (陣列)：等待時間簡訊互動

• in_call_sms (陣列)：通話期間的簡訊互動

• dispositions (陣列)：通話期間記錄的處置方式

• email (字串、電子郵件或空值)：顧客的電子郵件地址

• feedback (字串或空值)：顧客意見回饋

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

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

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

主要定義

結構定義也包含定義區段，可定義可重複使用的結構定義元件：

• menu_path：階層式選單路徑

• agent：真人服務專員

• virtual_agent：虛擬服務專員

• deflection：定義可能的轉移狀態