即時通訊轉錄稿中繼資料

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

結構定義根層級

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

通訊 ID comm_type 和 comm_id

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

• comm_type 代表通訊類型。這個值通常是 chat。如果語音通話包含混合簡訊轉錄稿內容，則可能為 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 值表示語音通話，其中包含混合的簡訊轉錄內容。

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

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

• assigned_at (字串，日期時間)：指派即時通訊的時間戳記。

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

轉錄稿項目

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

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

  • 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 (物件)：固定按鈕郵件內文。

  • 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 (字串，日期時間)：表單填寫事件發生的時間戳記。這與項目層級的 timestamp 不同，後者是以秒為單位的整數 Unix 紀元時間戳記。

    • 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 (字串；僅適用於含有 Chat 狀態的事件)：與事件相關聯的 Chat 狀態。

  • timeout (布林值；僅適用於逾時相關事件)：事件是否由逾時引起。

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

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

  • name (字串；僅適用於 virtual-agent 或 task-va 事件)：與事件相關聯的顯示名稱。

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

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

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

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

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

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

通知事件名稱

event 欄位會識別通知事件。即時通訊服務供應商是單一事實來源，會將下列清單中的所有通知事件，保留在轉錄稿 JSON 中。清單會依系列將這些事件分組。

智慧型動作要求

• verificationRequested

• photoRequested

• videoRequested

• screenshotRequested

• textRequested

• cobrowseRequestedFromAgent

智慧操作結果

• 完成時間：photoFinishedvideoFinishedscreenshotFinishedtextFinished
• 已取消：photoCanceled、videoCanceled、screenshotCanceled、textCanceled
• 失敗：photoFailed、videoFailed、screenshotFailed、textFailed、verificationFailed

驗證

• endUserVerified

共同瀏覽

• cobrowseRequestedFromEndUser

• cobrowseCodeGenerated

• cobrowseStarted

• cobrowseEnded

• cobrowseFailed

表單

• formRequested

• formSent

• formCompleted

移轉

• transferStarted

• transferAccepted

• transferFailed

虛擬服務專員提報

• escalationStarted

• escalationAccepted

• escalationDeflected

• escalationFailed

工作虛擬代理

• taskVaStarted

• taskVaFinished

成員資格

• agentJoined

• memberJoined

• memberLeft

工作階段生命週期

• chatEnded

• chatEndedWithPostSession

• chatDismissed

• chatReactivated

• checkInRequired

• checkInTimedOut

• transcriptRequested

• transcriptUpdated

自訂

• custom

如果記錄的 comm_type 設為 call，可能會顯示額外的通話轉錄通知事件。這些事件與通話或 Agent Assist 轉錄稿處理相關，而非一般的 Chat 事件系列。

定義

即時通訊轉錄稿中繼資料文件會顯示下列子結構定義。這個部分會定義每個子結構定義一次；參照這些子結構定義的屬性群組會指向這個部分，而不是在內嵌中重新定義其形狀。

entry (object)

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

user_data (物件)

說明轉錄項目寄件者 (如有寄件者中繼資料)。agent、manager、virtual-agent、external-agent 和 task-virtual-agent 項目可包含 name、id 和 avatar_url。消費者和系統項目則會包含空白物件。

message body (object, oneOf)

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

participant role (string, enum)

識別轉錄項目寄件者類別。

接受的值

• end_user - 消費者。

• agent：真人服務專員。

• manager - 管理員出席者。

• virtual_agent：虛擬服務專員。

• external_agent：外部代理參與者。

• task_virtual_agent：任務虛擬代理。

• system：系統產生的項目。

版本管理與淘汰

即時通訊轉錄稿中繼資料文件支援回溯相容的結構定義演變。系統可能會不時新增欄位和郵件內文變體，整合時應忽略任何無法辨識的金鑰，確保功能持續運作。

目前格式版本

• transcript_version (字串) - 目前的值："1.0"。整合功能應根據酬載中的欄位剖析轉錄稿，且不應因未來版本新增欄位或訊息內文類型而失敗。

不明的郵件內文類型

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

已淘汰的欄位

這份文件並未列出即時通訊轉錄稿中繼資料記錄的任何已淘汰欄位。