即時通訊轉錄稿中繼資料

本文說明即時通訊記錄中繼資料記錄的結構定義。這是 Contact Center AI 平台 (CCAI 平台) 為完成的即時通訊記錄生成的 JSON 檔案。對話記錄中繼資料記錄是由對話記錄 JSON 匯出功能產生，並可透過 CRM 轉錄稿上傳和外部儲存空間轉錄稿檔案傳送，具體取決於您的執行個體設定。您可以使用這個結構定義剖析轉錄稿 JSON、驗證收到的酬載，或將轉錄稿訊息對應至下游系統。

結構定義根層級

對話轉錄稿中繼資料記錄是代表單一對話轉錄稿構件的 JSON 物件。根層級的欄位會識別通訊內容、轉錄稿格式版本，以及轉錄稿項目的排序集。

通訊 ID comm_type 和 comm_id

comm_type 和 comm_id 會共同識別這份轉錄稿記錄所代表的通訊內容。

• comm_type 代表通訊類型。值通常為 chat。這可能是指包含混合式 SMS 轉錄稿內容的語音通話。call

• comm_id 是轉錄稿代表的即時通訊或通話 ID。

格式版本 transcript_version

用來識別 JSON 轉錄稿格式的版本。整合應使用這個欄位進行向前相容的剖析，並忽略無法辨識的欄位。

項目鑑別器 - entries[].type 和 entries[].body.type

entries 中的每個項目都代表一則轉錄稿訊息或事件。入門層級的 type 欄位會反映郵件內文類型。巢狀 body 物件會攜帶酬載，其形狀會因類型而異，例如 text、markdown、photo、noti 或 action。

即時通訊轉錄稿中繼資料結構定義

這個結構定義說明即時通訊記錄的資料結構。以下各節說明核心元件。

核心轉錄稿資訊

下列屬性提供轉錄稿本身的基本資訊：

• comm_type (字串)：轉錄稿代表的通訊類型。可能的值：chat、call。值 call 表示含有混合式 SMS 轉錄內容的語音通話。

• comm_id (整數)：轉錄稿所代表通訊內容的專屬 ID。

• transcript_version (字串)：轉錄稿 JSON 格式的版本。目前值為 "1.0"。請參閱「版本管理和淘汰項目」。

• assigned_at (字串，日期時間)：指派對話的時間戳記。

• timezone (字串)：轉錄稿內容的時區，例如 "America/Los_Angeles"。

轉錄稿項目

• entries (陣列)：轉錄稿項目的排序清單。每個項目代表對話中的一則訊息、通知或動作。

  • timestamp (整數)：系統建立項目時的 Unix Epoch 時間戳記 (以秒為單位)。

  • type (字串)：郵件內文類型。這個值會反映 body.type。如要瞭解支援的車身類型，請參閱「定義」。

  • body (物件)：項目酬載。形狀取決於 type / body.type 的值。

  • role (字串)：產生項目的參與者或系統元件的角色。可能的值：end_user、agent、manager、virtual_agent、external_agent、task_virtual_agent、system。

  • user_data (物件)：傳送者中繼資料。如果是 agent、manager、virtual_agent、external_agent 和 task_virtual_agent 項目，這個物件會包含寄件者的顯示資料。如果是 end_user 和 system 項目，這個物件會是空白。

    • name (字串；只有在寄件者中繼資料可用時才會顯示)：寄件者的顯示名稱。

    • id (整數；僅在提供寄件者中繼資料時顯示)：寄件者的 ID。

    • avatar_url (字串，URI；僅在提供傳送者中繼資料時顯示)：傳送者顯示圖片的網址。

簡訊內文

• text (物件)：純文字訊息內文。

  • type (字串)：一律為 text。

  • content (字串)：訊息文字。

  • lang (字串；僅在提供語言中繼資料時顯示)：與訊息相關聯的語言代碼。

• text_template (物件)：範本文字訊息內文。

  • type (字串)：一律為 text_template。

  • content (字串)：範本文字。

• markdown (物件)：以 Markdown 格式設定的郵件內文。

  • type (字串)：一律為 markdown。

  • content (字串)：Markdown 內容。

  • lang (字串；僅在提供語言中繼資料時顯示)：與訊息相關聯的語言代碼。

• markdown_template (物件)：以範本建立的 Markdown 郵件內文。

  • type (字串)：一律為 markdown_template。

  • content (字串)：Markdown 範本內容。

媒體和檔案訊息內文

• photo (物件)：相片或螢幕截圖郵件內文。

  • type (字串)：一律為 photo。

  • media_id (整數)：儲存的相片媒體 ID。

• video (物件)：影片訊息內文。

  • type (字串)：一律為 video。

  • media_id (整數；系統將影片儲存為 CCAI 平台媒體時會顯示)：儲存的影片媒體 ID。

  • title (字串；內嵌影片物件代表影片時會顯示)：影片標題。

  • video (物件；內嵌影片物件代表影片時存在)：影片詳細資料。

    • url (字串，URI)：影片網址。

    • text (字串)：影片的替代文字或備用網址。

• image (物件)：圖片訊息主體。

  • type (字串)：一律為 image。

  • title (字串；訊息傳送者提供時會顯示)：圖片標題。

  • image (物件)：圖片詳細資料。

    • url (字串，URI)：圖片的網址。

    • text (字串)：圖片的替代文字或備用網址。

• document (物件)：郵件內文。

  • type (字串)：一律為 document。

  • media_id (整數；系統將文件儲存為 CCAI 平台媒體時會顯示)：儲存的文件媒體 ID。

  • title (字串；當內嵌文件物件代表文件時存在)：文件標題。

  • document (物件；當內嵌文件物件代表文件時存在)：文件詳細資料。

    • url (字串，URI)：文件的網址。

    • text (字串)：文件的替代文字或備用網址。

• audio (物件)：語音訊息內文。

  • type (字串)：一律為 audio。

  • media_id (整數；系統將音訊儲存為 CCAI 平台媒體時會顯示)：儲存的音訊媒體 ID。

  • title (字串；內嵌音訊物件代表音訊檔案時會顯示)：音訊檔案的標題。

  • audio (物件；當內嵌音訊物件代表音訊檔案時存在)：音訊詳細資料。

    • url (字串，URI)：音訊檔案的網址。

    • text (字串)：音訊檔案的替代文字或備用網址。

互動式訊息內文

• inline_button (物件)：內嵌按鈕郵件內文。

  • type (字串)：一律為 inline_button。

  • title (字串)：顯示在按鈕上方的標題。

  • buttons (陣列)：按鈕定義清單。

    • title (字串)：按鈕標籤。

    • action (字串)：與按鈕相關聯的動作。

    • link (字串，URI；僅適用於連結樣式的快速回覆)：與按鈕相關聯的網址。

• sticky_button (object)：固定按鈕郵件內文。

  • type (字串)：一律為 sticky_button。

  • title (字串)：顯示在按鈕上方的標題。

  • buttons (陣列)：按鈕定義清單。

    • title (字串)：按鈕標籤。

    • action (字串)：與按鈕相關聯的動作。

    • link (字串，URI；僅適用於連結樣式的快速回覆)：與按鈕相關聯的網址。

• content_card (物件)：內容卡片郵件內文。

  • type (字串)：一律為 content_card。

  • cards (陣列)：內容資訊卡清單。

    • title (字串)：資訊卡標題。

    • body (字串；僅在設定資訊卡內文時顯示)：資訊卡內文。

• form_complete (物件)：消費者完成、失敗或取消表單時，用戶端傳送的表單完成訊息主體。

  • type (字串)：一律為 form_complete。

  • signature (字串；僅在完成事件包含簽章時顯示)：表單完成酬載的簽章。

  • data (物件)：表單填寫詳細資料。

    • status (字串)：完成狀態。可能的值：success、error、cancelled。

    • smart_action_id (整數)：與表單相關聯的智慧動作 ID。

    • timestamp (字串，日期時間)：表單填寫完成事件發生時的時間戳記。這與整數 Unix 時間戳記 (以秒為單位) 的入門層級 timestamp 不同。

    • details (物件；只有在酬載提供額外的完成詳細資料時才會顯示)：額外的狀態詳細資料。

      • error_code (字串；僅適用於有代碼的錯誤)：與完成結果相關的錯誤代碼。

      • message (字串)：使用者可自然閱讀的狀態詳細資料。

伺服器產生和直通的訊息內文

• server_message (物件)：伺服器產生的郵件內文。只有在為帳戶啟用工作虛擬代理轉錄內容時，轉錄稿才會包含 server_message 項目，否則轉錄稿會省略這些項目。如果轉錄稿參照儲存在伺服器端的訊息，請使用這個物件。

  • type (字串)：一律為 server_message。

  • message_id (整數)：儲存的伺服器訊息 ID。

  • visibility (字串或空值)：已儲存伺服器訊息的顯示設定。

• passthrough (物件)：系統透過 CCAI 平台傳遞的自訂酬載，適用於虛擬代理程式或 CCaaS 整合。您的整合定義了 content，但這並非 CCAI Platform 架構的一部分，請將其視為不透明。

  • type (字串)：一律為 passthrough。

  • content (字串或物件)：整合定義的酬載。結構會因整合而異，且 CCAI Platform 不會解讀。

動作訊息內文

• action (物件)：虛擬代理或聊天機器人流程要求的動作。action 欄位會決定動作酬載形狀。

  • type (字串)：一律為 action。

  • action (字串)：動作類型。可能的值包括 escalation、deflection 和 end。

  • escalation_reason (字串；只有在 action 為 escalation 時才會顯示)：對話升級的原因。

  • menu_id (整數；只有在 action 為 escalation 時才會顯示)：對話應轉接的選單 ID。

  • language (字串；只有在 action 為 escalation 時才會顯示)：目的地佇列的語言代碼。

  • deflection_type (字串；只有在 action 為 deflection 時才會顯示)：要求的偏轉類型。

  • sip_parameters (物件或空值；僅在 action 為 deflection 時存在)：要轉送的 SIP 參數，做為轉接的一部分。

通知訊息內文

• noti (物件)：通知郵件內文。通知會說明對話期間發生的系統事件。

  • type (字串)：一律為 noti。

  • event (字串)：通知事件名稱。

  • agent (物件；僅適用於與真人服務專員相關聯的事件)：與事件相關聯的服務專員。

    • id (整數)：代理 ID。

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

    • name (字串)：代理程式顯示名稱。

  • from_agent (物件；僅適用於有來源代理程式的轉移事件)：事件的來源代理程式。

    • id (整數)：代理 ID。

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

    • name (字串)：代理程式顯示名稱。

  • to_agent (物件；僅適用於目的地為真人服務專員的轉移或升級事件)：事件的目的地真人服務專員。

    • id (整數)：代理 ID。

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

    • name (字串)：代理程式顯示名稱。

  • from_virtual_agent (物件；僅適用於虛擬代理的升級事件)：事件的來源虛擬代理。

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

    • name (字串)：虛擬代理程式顯示名稱。

    • avatar_url (字串、URI 或空值)：虛擬代理程式顯示圖片的網址。

  • to_virtual_agent (物件；僅在轉移至虛擬代理程式的事件中顯示)：事件的目的地虛擬代理程式。

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

    • name (字串)：虛擬代理程式顯示名稱。

    • avatar_url (字串、URI 或空值)：虛擬代理程式顯示圖片的網址。

  • target (字串；僅適用於轉移事件)：轉移目的地類型。可能的值包括 menu 和 agent。

  • status (字串；僅適用於攜帶即時通訊狀態的事件)：與事件相關聯的即時通訊狀態。

  • timeout (布林值；僅適用於逾時相關事件)：逾時是否導致事件發生。

  • memberIdentity (字串；僅適用於參與者加入或離開活動的事件)：參與者的身分。

  • memberName (字串；僅適用於參與者加入或離開事件)：參與者的顯示名稱。

  • name (字串；僅適用於虛擬代理程式或工作虛擬代理程式事件)：與事件相關聯的顯示名稱。

  • reason (字串；僅適用於 task-va 完成事件)：task-va 工作階段的結束原因。

  • escalation_reason (字串；僅適用於提報事件)：提報原因。

  • deflection (物件；僅適用於轉移事件)：轉移詳細資料。

  • detail (物件；僅適用於自訂通知事件)：自訂事件詳細資料。

    • key (字串)：自訂事件鍵。

    • data (物件)：自訂事件酬載。

通知事件名稱

event 欄位會識別通知事件。即時通訊服務供應商是單一可靠資料來源，會將下列清單中的所有通知事件保留在轉錄稿 JSON 中。這份清單會依家庭群組列出這些活動。

智慧動作要求

• verificationRequested

• photoRequested

• videoRequested

• screenshotRequested

• textRequested

• cobrowseRequestedFromAgent

智慧動作成果

• 已完成：photoFinished、videoFinished、screenshotFinished、textFinished

• 已取消：photoCanceled、videoCanceled、screenshotCanceled、textCanceled、cobrowseCanceled

• 失敗：photoFailed、videoFailed、screenshotFailed、textFailed、verificationFailed

驗證

• endUserVerified

共同瀏覽

• cobrowseRequestedFromEndUser

• cobrowseCodeGenerated

• cobrowseStarted

• cobrowseEnded

• cobrowseFailed

表單

• formRequested

• formSent

• formCompleted

移轉

• transferStarted

• transferAccepted

• transferFailed

虛擬服務專員提報

• escalationStarted

• escalationAccepted

• escalationDeflected

• escalationFailed

任務虛擬代理

• taskVaStarted

• taskVaFinished

成員資格

• memberJoined

• memberLeft

工作階段生命週期

• chatEnded

• chatEndedWithPostSession

• chatDismissed

• checkInRequired

• checkInTimedOut

• transcriptRequested

• transcriptUpdated

自訂

• custom

如果記錄的 comm_type 設為 call，可能會顯示其他通話轉錄通知事件。這類事件與通話或 Agent Assist 轉錄稿處理作業相關，而非一般的即時通訊事件系列。

定義

聊天記錄中繼資料文件會顯示下列子結構定義。本節會定義每個子結構定義一次；參照這些子結構定義的屬性群組會指向本節，而不是重新定義其形狀。

項目 (物件)

代表一則轉錄稿訊息、通知或動作。每個項目都有 Unix 紀元 timestamp、頂層 type、類型與該形狀相符的 body 物件、傳送者 role 和 user_data 物件。如需完整欄位清單，請參閱「轉錄稿項目」。

user_data (物件)

如果提供寄件者中繼資料，則說明轉錄稿項目的寄件者。「服務專員」、「管理員」、「虛擬服務專員」、「外部服務專員」和「工作虛擬服務專員」項目可攜帶 name、id 和 avatar_url。消費者和系統項目會攜帶空物件。

郵件內文 (物件，oneOf)

每個項目的 body 物件都會使用 body.type 的值，選取其中一個支援的訊息主體形狀。支援的內文類型包括文字內文、媒體或檔案內文、互動式內文、伺服器產生的內文、動作內文和通知內文。如需完整的記錄變體清單，請參閱「文字訊息內文」至「通知訊息內文」。

參與者角色 (字串、列舉)

識別轉錄稿項目的傳送者類別。

接受的值

• end_user - 消費者。

• agent - 真人服務專員。

• manager - 管理員出席者。

• virtual_agent - 虛擬代理。

• external_agent - 外部代理參與者。

• task_virtual_agent - 任務虛擬代理。

• system - 系統產生的項目。

版本管理與淘汰

聊天記錄中繼資料文件支援回溯相容的結構定義演進。系統可能會隨時間新增欄位和訊息主體變體，整合項目應忽略任何無法辨識的鍵，確保功能持續運作。

目前格式版本

• transcript_version (字串) - 目前值："1.0"。整合項目應根據酬載中的欄位剖析轉錄稿，且未來版本新增欄位或訊息主體類型時，不應發生錯誤。

不明的訊息內文類型

如果轉錄稿項目包含無法辨識的 type 或 body.type，請盡可能保留原始項目，並繼續剖析轉錄稿的其餘部分。系統可能會新增訊息主體類型，但不會變更現有欄位的意義。

已淘汰的欄位

這份文件未列出任何已淘汰的聊天記錄中繼資料記錄欄位。