資料提取 API

資料提取 API 可讓您從用於外部報告的 CXone 提取資料。 例如，您可以提取 CXone QM 工作流程資料、CXone QM 問答資料、CXone Recording 互動中繼資料或 CXone WFM 工資單資料。 資料只能根據既定日期範圍進行篩選。

資料提取 API 可於 DEVone 開發者社群入口網站供應。

關於網域和 URL 的詳細資訊，請查閱 DEVone 開發者入口網站中的開始使用。

在使用 POST 方法調用端點 /jobs 時，一個 jobId 將在準備資料時返回。 您可透過從端點輪詢服務來驗證資料是否準備就緒 /jobs/{jobId}，返回作業狀態。 如果狀態是成功，則將返回一條額外 URL。 該 URL 將在 30 秒內可供存取（不包括下載檔案所需時間）。

您可以編寫指令碼來定期調用 API 而不用每次都手動檢索資料。 在任何既定時間，每個租戶僅有一個使用者可以調用 API。 您只能在 30 秒內調用一次 API。

開始之前

在開始使用業務資料 API 之前，您必須設定使用者權限，產生存取金鑰，並遵循開發人員入口網站上所述的註冊和驗證流程。 所需權限：

  • 實體：

    • 如果要提取互動中繼資料，則需要搜尋及播放 > API > 提取互動中繼資料權限。

    • 如果您正在提取 CXone QM 工作流程資料，那麼您需要 品質管理工具 > 資料提取 API > 品質管理工作流程 API 權限。

    • 如果您正在提取CXone QM問答資料，那麼您需要品質管理工具 > 資料提取 API > 品質管理工作流程 API 權限。

    • 如果您要提取CXone WFM工資單資料，則您需要CXone WFM> 資料提取 API > CXone WFM工資單 API權限。

GET 工作

檢視每個租戶的所有作業狀態清單。 可能狀為正在運行、已成功、已失敗、已取消和已到期。

範例值

 "jobs": [ { "id": "9dd92a83-1234-8549-8df4-939485722942", "status": "RUNNING" }, { "id": "12345d5h-c099-2345-k3r3-w3ko9ppp1234", "status": "FAILED" } ] }

回應

  • Status 200 - Success. 檢索到所有作業狀態。

  • 狀態 401 - 未獲授權。 認證無效。

  • 狀態 403 - 已禁止。 使用者沒有檢視作業狀態的權限。

  • 狀態 500 - 內部伺服器錯誤。

POST作業

發出提取資料的請求後，將收集資料以準備提取。 資料在 S3 中以 CSV 檔案形式可用 24 小時。 完成後，將返回作業 ID。

請求正文*： application/json

exportRequest {
描述：

 

提取資料需要提供的參數。
entityName

字串

要提取實體的名稱。 有關正確的實體名稱，請參見下文。
版本

字串

要提取的實體版本。 請參閱下文以了解有關每個實體的正確版本。
startDate

string($date)

開始提取資料的日期 (UTC)。 日期格式為 <YYYY-MM-DD>。 例如：要提取 2019 年 5 月 22 日及之前的資料，請輸入日期：2019-05-22。
endDate

string($date)

停止提取資料的日期 (UTC)。 日期格式為 <YYYY-MM-DD>。 例如：要提取 2019 年 5 月 29 日及之前資料，請輸入日期：2019-05-29。
}  

範例值

{ "entityName": "qm-workflows", "version": "3", "startDate": "2019-05-22", "endDate": "2019-05-29" }

回應

  • Status 202 - Success. 已成功匯出非同步作業。

    字串

    例子：12345d5h-c099-9303-j99j-w3ko9ppp1234

  • 狀態 400 - 要求無效。 日期篩選器等不正確。

  • 狀態 401 - 未獲授權。 認證無效。

  • 狀態 403 - 已禁止。 使用者沒有檢視作業狀態的權限。

  • 狀態 404 - 未找到。 缺少實體或版本無效。

  • 狀態 500 - 內部伺服器錯誤。

按作業 ID 取得作業

根據作業 ID 檢視特定作業狀態。 如果作業成功，將返回一個用以提存資料的 URL，該 URL 可存取 30 秒（不包括下載檔案所需時間）。 如果作業失敗，則返回錯誤訊息。 該連結可用於存取提取的資料。 可能作業狀態為正在運行、已成功、已失敗、已取消和已到期。

jobId*：

字串

為提取客戶資料而發出之請求的唯一識別碼。

範例值

 12345d5h-r3ds-9303-0pw3-w3ko9ppp1234

回應

  • Status 202 - Success. 已檢索作業狀態。

     jobResponse{ description: Displays the job status jobStatus: { description: Job Status, includes job ID and job status id:	string Unique identifier of the job. status: string example: SUCCEEDED Job status that can be returned. Enum: [ RUNNING, SUCCEEDED, FAILED, CANCELLED, EXPIRED ] result: { description:	Job result. If successful, contains the url, if failed, an error message is displayed. url: string example: https://s3.example.amazonaws.com/results-bucket/data-extraction/{details} A url to access the extracted data is returned when a job for extracting data is successful. errorMessage: string Error message displayed when a request for extracting data fails. } } }

  • 狀態 400 - 要求無效。 日期篩選器等不正確。

  • 狀態 401 - 未獲授權。 認證無效。

  • 狀態 403 - 已禁止。 使用者沒有檢視作業狀態的權限。

  • 狀態 404 - 未找到。 缺少實體或版本無效。

  • 狀態 500 - 內部伺服器錯誤。

CXone QM 工作流程實體和 CSV 檔案

此 CXone QM Workflow API 允許您提取 CXone QM 工作流程資料，其中包括評估、自我評估和校正。

對於 POST 作業：

  • entityName 是qm-workflows。

  • 版本為：4

資料將根據 提交日期 (UTC) 進行篩選。

欄名稱

描述

租戶名稱

租戶名稱。

客服專員 ID

客服專員的唯一識別碼。

欄位類型：最多 36 個字元的字串 (VARCHAR)

類型

評估類型，例如：

  • 評估

  • 自我評估

欄位類型：最多 24 個字元的字串 (VARCHAR)

評估流程觸發器

開始評估的事件：

  • 校準

  • 協作的

  • 人手

  • QP

欄位類型：最多 24 個字元的字串 (VARCHAR)

工作流程狀態

工作流程狀態：

  • 已傳送給客服專員

  • 審視中

  • 糾紛

  • 已完成確認

  • 完成自我評估

  • 已完成已審視

  • 沒有完成任何審視

  • 已完成

  • 已刪除

  • 已刪除 - 已完成

  • 已過期

  • 已刪除 - 已過期

  • 已刪除 - 已完成並確認

  • 已刪除 - 已完成並核准

  • 已刪除 - 已完成，未核准

欄位類型：最多 128 個字元的字串 (VARCHAR)

已自動確認

可能值為：

  • TRUE：如果客服專員未確認評估，則會自動確認。

  • FALSE：如果客服專員確認評估。

  • 空值：自我評估的情況下，不需要確認。

欄位類型：布爾值

工作流程狀態

工作流程狀態：

  • 開啟

  • 已關閉

  • 逾時

欄位類型：最多 128 個字元的字串 (VARCHAR)

工作流程 ID

評估的唯一識別碼。

欄位類型：最多 36 個字元的字串 (VARCHAR)

API 版本：3 以上

計劃名稱

用以啟動此評估的品質計劃名稱。

欄位類型：最多 128 個字元的字串 (VARCHAR)

表格名稱

用於此評估的表單名稱。

欄位類型：最多 256 個字元的字串 (VARCHAR)

表格版本

用於此評估的評估表版本。

欄位類型：數字(4,0)

開始日期

此評估的開始日期和時間 (UTC)。

欄位類型：TIMESTAMP_LTZ(3)

提交日期

此評估的提交日期和時間 (UTC)。

欄位類型：TIMESTAMP_LTZ(3)

上次更新

上次修改此評估時的時間戳記 (UTC)。

欄位類型：TIMESTAMP_LTZ(3)

分數 - 百分比

以百分比表示的評估分數。

欄位類型：浮點值

分數

評估分數。

欄位類型：浮點值

最高可能分數

評估表單中每個問題的最高分數。

欄位類型：浮點值

排名

使用者設定的自訂值範圍以定義表單排名。

欄位類型：最多 256 個字元的字串 (VARCHAR)

未能正確回答關鍵問題

如果值為 True，則表示使用者未能正確回答關鍵問題，評估表分數將設定為零。

如果值為 False，則表示使用者正確回答了關鍵問題。

欄位類型：布爾值

使用者評論

使用者（客服專員）對評估提出異議時輸入的評論。

欄位類型：最多 256 個字元的字串 (VARCHAR)

爭議解決者評論

使用者（經理／評估者）在結束爭議時輸入的評論。

欄位類型：最多 256 個字元的字串 (VARCHAR)

分段 ID

所評估之互動的分段 ID。

欄位類型：最多 36 個字元的字串 (VARCHAR)

ACD ID

自動呼叫指派器的唯一識別碼。

欄位類型：數字(38,0)

互動類型

互動類型：

  • PHONE_CALL

  • 電郵

  • 聊天

  • SMS

  • WORKITEM

  • GOOGLE_BUSINESS_MESSAGES_PRIVATE

  • APPLE_BUSINESS_CHAT_PRIVATE

  • TELEGRAM_PRIVATE

  • LINE_PRIVATE

  • WHATSAPP_PRIVATE

  • SLACK_PRIVATE

  • MICROSOFT_TEAMS_PRIVATE

  • TW_PRIVATE

  • VIBER_PRIVATE

  • CUSTOM_PRIVATE

  • WE_CHAT_PRIVATE

  • FB_PRIVATE

欄位類型：最多 50 個字元的字串 (VARCHAR)

互動開始日期

互動的開始日期/時間 (UTC)。

欄位類型：TIMESTAMP_LTZ(6)

互動結束日期

互動的結束日期/時間 (UTC)。

欄位類型：TIMESTAMP_LTZ(6)

互動方向

通話方向：

  • 傳入

  • 傳出

欄位類型：最多 50 個字元的字串 (VARCHAR)

團隊 ID

客服專員所屬團隊的唯一識別碼。

欄位類型：最多 36 個字元的字串 (VARCHAR)

團隊名稱

客服專員的團隊名稱。

欄位類型：最多 50 個字元的字串 (VARCHAR)

電話號碼

客戶的電話號碼。

欄位類型：最多 200 個字元的字串 (VARCHAR)

名字（評估者）

評估者的名字。

欄位類型：最多 255 個字元的字串 (VARCHAR)

姓氏（評估者）

評估者的姓氏。

欄位類型：最多 255 個字元的字串 (VARCHAR)

名字（客服專員）

所評估之客服專員的名字。

欄位類型：最多 255 個字元的字串 (VARCHAR)

姓氏（客服專員）

所評估之客服專員的姓氏。

欄位類型：最多 255 個字元的字串 (VARCHAR)

名字（爭議解決者）

爭議解決者的名字。

欄位類型：最多 255 個字元的字串 (VARCHAR)

姓氏（爭議解決者）

爭議解決者的姓氏。

欄位類型：最多 255 個字元的字串 (VARCHAR)

名字（指派者）

指派評估之使用者的名字。

欄位類型：最多 255 個字元的字串 (VARCHAR)

姓氏（指派者）

指派評估之使用者的姓氏。

欄位類型：最多 255 個字元的字串 (VARCHAR)
原因

刪除評估的原因。

欄位類型：最多 128 個字元的字串 (VARCHAR)

API 版本：4 以上
主 ID

評估的上層工作流程 Id，例如協作和校正。

欄位類型：最多 36 個字元的字串 (VARCHAR)

API 版本：4 以上
評估主題

可能值為：

  • 僱員

  • 分段

欄位類型：最多 128 個字元的字串 (VARCHAR)

API 版本：4 以上

CXone QM 問答 (Q&A) 實體和 CSV 檔案

CXone QM 問答 API 允許您從 CXone QM 評估、自我評估和校正提取問題及答案。

對於 POST 作業：

  • entityName 是 qm-questions。

  • 版本是：2

資料將根據 提交日期 (UTC) 進行篩選。

欄名稱

描述

問題 ID

問題的唯一識別碼。

欄位類型：數字(38,0)
問題標題

問題文字。

欄位類型：最多 2048 個字元的字串 (VARCHAR)
問題編號

評估表格內的問題之編號。

欄位類型：最多 15 個字元的字串 (VARCHAR)
答案

評估者對問題的回答。

欄位類型：最多 10000 個字元的字串 (VARCHAR)
選項

問題的適用答案選項，例如是／否、數字選項、單選按鈕選項等。

欄位類型：陣列
表單 ID

評估表的唯一識別碼。

欄位類型：最多 36 個字元的字串 (VARCHAR)

表格名稱

用於此評估的表單名稱。

欄位類型：最多 256 個字元的字串 (VARCHAR)

表格版本

用於此評估的評估表版本。

欄位類型：數字(4,0)
評估開始日期

此評估的開始日期和時間 (UTC)。

欄位類型：TIMESTAMP_LTZ(3)
評估提交日期

此評估的提交日期和時間 (UTC)。

欄位類型：TIMESTAMP_LTZ(3)

工作流程類型

評估類型，例如：

  • 評估

  • 自我評估

欄位類型：最多 24 個字元的字串 (VARCHAR)
區段 ID 評估表內區段的唯一識別碼。

欄位類型：數字(38,0)
區段標題

評估表內區段的部分名稱。

欄位類型：最多 2048 個字元的字串 (VARCHAR)
可得分

是否可以對問題進行評分的 True 或 False 標幟。

欄位類型：布爾值
實際分數

客服專員在問題上得到的分數。

欄位類型：浮點值
區段得分 (%)

問題所在部分的百分比分數。

欄位類型：浮點值
最高分數

客服專員在該問題上可能獲得的最高分數。

欄位類型：浮點值

客服專員 ID

客服專員的唯一識別碼。

欄位類型：最多 36 個字元的字串 (VARCHAR)

名字（客服專員）

所評估之客服專員的名字。

欄位類型：最多 255 個字元的字串 (VARCHAR)

姓氏（客服專員）

所評估之客服專員的姓氏。

欄位類型：最多 255 個字元的字串 (VARCHAR)

團隊 ID

客服專員所屬團隊的唯一識別碼。

欄位類型：最多 36 個字元的字串 (VARCHAR)

團隊名稱

客服專員的團隊名稱。

欄位類型：最多 50 個字元的字串 (VARCHAR)

名字（評估者）

評估者的名字。

欄位類型：最多 255 個字元的字串 (VARCHAR)

姓氏（評估者）

評估者的姓氏。

欄位類型：最多 255 個字元的字串 (VARCHAR)
關鍵

判斷問題是否為關鍵問題的 True 或 False 標幟。

欄位類型：布爾值

未能正確回答關鍵問題

如果值為 True，則表示使用者未能正確回答關鍵問題，評估表分數將設定為零。

如果值為 False，則表示使用者正確回答了關鍵問題。

欄位類型：布爾值
強制

如果問題為必答問題，則為 True 或 False 標幟。

欄位類型：布爾值
問題類型

問題類型：

  • 收音機

  • 是／否

  • 核取方塊

  • 下拉

  • 日期/時間

欄位類型：最多 64 個字元的字串 (VARCHAR)

分段 ID

所評估之互動的分段 ID。

欄位類型：最多 36 個字元的字串 (VARCHAR)

互動開始日期

互動的開始日期/時間 (UTC)。

欄位類型：TIMESTAMP_LTZ(6)

互動結束日期

互動的結束日期/時間 (UTC)。

欄位類型：TIMESTAMP_LTZ(6)

工作流程執行個體 ID

評估的唯一識別碼。

欄位類型：最多 36 個字元的字串 (VARCHAR)

評估分數 (%)

評估的百分比分數。

欄位類型：浮點值

問題庫 ID

問題所在題庫的唯一識別嗎。

欄位類型：最多 36 個字元的字串 (VARCHAR)
隱藏名稱

True 旗標隱藏問題，False 旗標顯示問題。 在品質表單中使用 QM 表單規則時，其會根據前一個問題的分數隱藏後續問題。

欄位類型：布爾值

API 版本：2 以上

CXone QM評估者備註和 CSV 檔案

透過 CXone QM 評估者備註 API，您可以提取CXone QM評估者備註。

對於 POST 作業：

  • entityName是：qm-evaluation-comment-entity

  • 版本是：1

資料將根據 提交日期 (UTC) 進行篩選。

欄名稱

描述

備註 ID

備註的唯一識別碼。

欄位類型：最多 36 個字元的字串 (VARCHAR)

備註

備註文字。

欄位類型：最多 300 個字元的字串 (VARCHAR)

評論時間

新增備註的日期和時間。

欄位類型：TIMESTAMP_LTZ(3)

活動

新增備註時的評估動作名稱。

欄位類型：最多 50 個字元的字串 (VARCHAR)

備註 ID

新增備註的使用者的唯一識別碼。

欄位類型：最多 36 個字元的字串 (VARCHAR)

備註者名

新增備註的使用者名。

欄位類型：最多 255 個字元的字串 (VARCHAR)

備註者姓氏

新增備註的使用者的姓。

欄位類型：最多 255 個字元的字串 (VARCHAR)

問題 ID

問題的唯一識別碼。

欄位類型：最多 36 個字元的字串 (VARCHAR)

問題標題

問題文字。

欄位類型：最多 2048 個字元的字串 (VARCHAR)

表單 ID

評估表單的唯一識別碼。

欄位類型：最多 36 個字元的字串 (VARCHAR)

表格名稱

用於此評估的表單名稱。

欄位類型：最多 256 個字元的字串 (VARCHAR)

表格版本

用於此評估的評估表單版本。

欄位類型：數字(4,0)

工作流程 ID

評估的唯一識別碼。

欄位類型：最多 36 個字元的字串 (VARCHAR)

工作流程狀態

工作流程的狀態。

欄位類型：最多 128 個字元的字串 (VARCHAR)

客服專員 ID

客服專員的唯一識別碼。

欄位類型：最多 36 個字元的字串 (VARCHAR)

名字（客服專員）

客服專員的名。

欄位類型：最多 255 個字元的字串 (VARCHAR)

姓氏（客服專員）

客服專員的姓。

欄位類型：最多 255 個字元的字串 (VARCHAR)

團隊 ID

客服專員所屬團隊的唯一識別碼。

欄位類型：最多 36 個字元的字串 (VARCHAR)

團隊名稱

客服專員的團隊名稱。

欄位類型：最多 50 個字元的字串 (VARCHAR)

互動中繼資料實體和 CSV 檔案

互動中繼資料 API 允許您提取 CXone Recording 互動中繼資料。

對於 POST 作業：

  • entityName 是 recording-interaction-metadata。

  • 版本是：7

  • 要按日期和時間篩選資料，請使用startDate 和 endDate (UTC)，格式：yyyy-mm-dd hh:mm:ss

欄名稱

描述

ACD 通話 ID（例如：主要聯絡 ID）

ACD 通話 ID 取決於 ACD 解決方案，例如：這與 CXone 主聯絡 IDClosed 一次或多次相關聯絡的主 ID 或上層 ID。 如果某次聯絡被轉移了 3 次或以上，則會指派新的主聯絡 ID。 相同。

欄位類型：最多 38 位數字

分段 ID

分段的唯一識別碼。 分段是與兩方（例如客戶和客服專員）的互動。

欄位類型：最多 36 個字元的字串 (VARCHAR UUID)

分段開始原因

分段開始的原因：

  • 會議

  • IVR

  • 分段：聯絡的第一段

  • 轉移

  • 聯絡

  • 已提升

  • 轉移到外部號碼

  • 外部轉移

欄位類型：最多 100 個字元的字串 (VARCHAR)

分段結束原因

分段結束的原因：

  • 會議

  • IVR

  • 分段：聯絡的最後一段

  • 轉移

  • 聯絡

  • 已提升

  • 轉移到外部號碼

  • 外部轉移

欄位類型：最多 100 個字元的字串 (VARCHAR)
通話方向

分段方向：

  • 傳入

  • 傳出

  • 內部

  • 未知

欄位類型：最多 150 個字元的字串 (VARCHAR)

開始日期

分段的開始日期和時間 (UTC)。

欄位類型：時間戳

結束日期

分段的結束日期和時間 (UTC)。

欄位類型：時間戳
通道類型

互動類型：

  • 語音

  • 聊天

  • 電郵

  • IVR

  • 工作項目

  • SMS

  • 訊息傳送通道：Facebook Messenger、Twitter Direct Messages、WhatsApp、Apple Messages for Business(Apple Business Chat)、LINE Messaging、Telegram Messenger、Viber Messenger、Custom、Google Business Messenger、Microsoft Teams、Slack。

  • 公共社交通道：Facebook、Google Places、Google Play、LinkedIn、Twitter、YouTube、Apple Apps Reviews、自訂（公共）。

欄位類型：最多 150 個字元的字串 (VARCHAR)
螢幕錄影

如果該分段包含螢幕錄製：

  • 是

  • 否
錄音狀態

錄製狀態：

  • 成功

  • 已部分錄製：此分段有一些部分未錄製，但仍可以重播互動

  • 不符合任何原則：無錄製—此互動未觸發任何錄製原則

  • 由於錄製 % 而未錄製：無錄製—此互動觸發了錄製原則，但由於此原則中定義的錄製百分比而未進行錄製

  • 不符合任何錄製原則：無錄製—此互動未觸發任何錄製原則

  • IVR 中已拒絕同意：無錄製

  • 已失敗：無錄製

  • 遮罩：無錄製—錄製被遮罩

  • 記錄傳送至未選擇的外部號碼：無錄製

  • 沒有選擇可錄製（語音）：無錄製—未選擇客服專員屬性可錄製（語音）

欄位類型：最多 250 個字元的字串 (VARCHAR)
螢幕錄製狀態

錄製狀態：

  • 成功

  • 已部分錄製：此分段有一些部分未錄製，但仍可以重播互動

  • 不符合任何原則：無錄製—此互動未觸發任何錄製原則

  • 由於錄製 % 而未錄製：無錄製—此互動觸發了錄製原則，但由於此原則中定義的錄製百分比而未進行錄製

  • 不符合任何錄製原則：無錄製—此互動未觸發任何錄製原則

  • IVR 中已拒絕同意：無錄製

  • 已失敗：無錄製

  • 遮罩：無錄製—錄製被遮罩

欄位類型：最多 250 個字元的字串 (VARCHAR)

錄製警示

錄製警示包括：

  • ScreenAgent 錯誤：有多種原因，例如客服專員沒有安裝ScreenAgentClosed NICE ScreenAgent 服務在需要螢幕錄製的客服專員桌面執行。，或者ScreenAgent出現錯誤。 請參閱 解決 ScreenAgent 問題。

  • 沒有連接到媒體伺服器：沒有記錄。 媒體伺服器有問題。 可能有多種原因。 錄製提醒的錯誤描述提供了更多詳細資訊。

  • 錄音機無法記錄通話：沒有記錄。 錄音機有問題。 可能有多種原因。 錄製提醒的錯誤描述提供了更多詳細資訊。

  • 音訊不可用：音訊資料不完整 ：音訊不可用於此互動（音訊資料不完整）。 聯絡 NICE CXone 支援人員。

  • 音訊不可用：音訊封包遺失：音訊不可用於此互動（音訊封包遺失）。 聯絡 NICE CXone 支援人員。

  • 音訊不可用：缺少外部來源的音訊封包：（CR 功能）音訊不可用於此互動（媒體串流中缺少音訊資料封包）。 聯絡 NICE CXone 支援人員。

  • 系統錯誤：錄音沒有開始或其他一般錯誤。 聯絡 NICE CXone 支援人員。

  • 通話時間太短：通話時間不足 4 秒，因此無法錄音。

  • 遮罩失敗：遮罩錄音失敗。 您可以播放記錄以檢查是否存在任何敏感資料。 若要刪除記錄，請點擊動作圖示動作按鈕的螢幕截圖，並選擇刪除記錄。

  • 按需停止錄音：使用者已停止錄音。

原則名稱

記錄原則的名稱或套用至此互動的「不記錄」原則。

欄位類型：最多 100 個字元的字串 (VARCHAR)
ANI

就來電而言，ANI 是來電者的電話號碼（呼叫者 ID）。

欄位類型：最多 200 個字元的字串 (VARCHAR)
DNIS

對於來電，DNIS 是來電（撥入號碼）的電話號碼。

欄位類型：最多 200 個字元的字串 (VARCHAR)
ACW（以秒為單位）

通話結束後繼續進行多少秒的螢幕錄製以擷取客服專員的通話後作業。
處置方式 客服專員指派的標記，具有關於通話的其他資訊。
客服專員使用者 ID

指派給客服專員的唯一識別碼。

CSV 檔案最多可以包含 5 個客服專員的相關資訊。 例如：Agent1 使用者 ID、Agent2 使用者 ID、Agent3 使用者 ID、Agent4 使用者 ID 和 Agent5 使用者 ID。

欄位類型：最多 36 個字元的字串 (VARCHAR)
客服專員 ACD ID

ACD 指派給客服專員的唯一識別碼。

CSV 檔案最多可以包含 5 個客服專員的相關資訊。 例如：Agent1 ACD ID、Agent2 ACD ID、Agent3 ACD ID、Agent4 ACD ID 和 Agent5 ACD ID。

欄位類型：最多 50 個字元的字串 (VARCHAR)
客服專員聯絡號碼

為此客服專員建立的聯絡的唯一識別碼。

CSV 檔案最多可以包含 5 個客服專員的相關資訊。 例如：Agent1 聯絡號碼、Agent2 聯絡號碼、Agent3 聯絡號碼、Agent4 聯絡號碼和 Agent5 聯絡號碼。

此欄位不適用於CXone Multi-ACD。

欄位類型：最多 38 位數字

API 版本：5 以上

客服專員名稱

客服專員姓名中指定的 CXone 員工帳戶。

CSV 檔案最多可以包含 5 個客服專員的相關資訊。 例如：Agent1 名稱、Agent2 名稱、Agent3 名稱、Agent4 名稱和 Agent5 名稱。

欄位類型：最多 100 個字元的字串 (VARCHAR)

客服專員團隊 ID

指派給客服專員團隊的唯一識別碼。

CSV 檔案最多可以包含 5 個客服專員的相關資訊。 例如：Agent1 團隊 ID、Agent2 團隊 ID、Agent3 團隊 ID、Agent4 團隊 ID 和 Agent5 團隊 ID。

欄位類型：最多 36 個字元的字串 (VARCHAR UUID)

客服專員團隊

客服專員的團隊名稱。

CSV 檔案最多可以包含 5 個客服專員的相關資訊。 例如：Agent1 團隊、Agent2 團隊、Agent3 團隊、Agent4 團隊和 Agent5 團隊。

欄位類型：最多 40 個字元的字串 (VARCHAR)

客服專員技能

根據能力、專業和知識指派給 ACD 的客服專員分類。

CSV 檔案最多可以包含 5 個客服專員的相關資訊。 例如：Agent1 技能、Agent2 技能、Agent3 技能、Agent4 技能和 Agent5 技能。

欄位類型：最多 50 個字元的字串 (VARCHAR)

相關聯絡人編號清單

與分段相關聯的客服專員的聯絡人電話清單。 此清單中的元素僅為數位類型。

欄位類型：變體

API 版本：7 以上

互動 ID

互動的唯一 ID (UUID)。 當一個互動有多個分段時，這些分段可以有相同的互動 ID。 互動 ID 與分段 ID 或連絡人 ID 不一致。

欄位類型：最多 36 個字元的字串 (VARCHAR)

API 版本：7 以上

業務資料名稱

指定的業務資料欄位的名稱。

欄位類型：最多 128 個字元的字串 (VARCHAR)

API 版本：7 以上

業務資料值

業務資料值可以是文字、數位或 True/False。

業務資料最多可包含 50 個欄位—35 個 varchar、10 個數值和 5 個布爾值。

欄位類型：

  • 最多 4000 個字元的字串 (VARCHAR)

  • 最多包含 38 位數的數值 (NUMBER)

  • 由 TRUE 或 FALSE 組成的布爾值 (BOOLEAN)

API 版本：7 以上

來源

錄音的來源—CXone 或外部來源。 值包括：

  • Engage

  • BrandEmbassy

  • Uptivity

  • InContactACD

  • 多 ACD

  • MigratedCallsExternal

  • MigratedCallsEngage

  • MigratedCallsNim

欄位類型：最多 30 個字元的字串 (VARCHAR)

API 版本：6 以上

外部聯絡 ID

在錄音的外部來源中定義的聯絡 ID。 值僅適用於CXone AppLink的使用者。

欄位類型：最多 100 個字元的字串 (VARCHAR)

API 版本：6 以上

外部分段 ID

在錄音的外部來源中定義的分段 ID。 值僅適用於CXone AppLink的使用者。

欄位類型：最多 100 個字元的字串 (VARCHAR)

API 版本：6 以上

CXone WFM 工資單實體和 CSV 檔案

CXone WFM工資單 API（版本 1）允許您提取CXone WFM活動資料，以用於外部工資單報告。

CXone WFM POST 作業的工資單實體名稱為：wfm-payroll。

資料將根據工資單代碼的日期篩選。 請注意，日期和時間的時區取決於排程單元的時區。

欄名稱

描述

名字

客服專員的名字。

欄位類型：最多 255 個字元的字串 (VARCHAR)

姓氏

客服專員的姓氏。

欄位類型：最多 255 個字元的字串 (VARCHAR)

用戶名稱

客服專員的使用者名稱。

欄位類型：最多 255 個字元的字串 (VARCHAR)

調度單元

客服專員的排程單元。

欄位類型：最多 256 個字元的字串 (VARCHAR)

排程單元的時區

客服專員的排程單元的時區。

欄位類型：最多 128 個字元的字串 (VARCHAR)

工資單代碼

包含已排程活動資料的工資單代碼。

欄位類型：最多 50 個字元的字串 (VARCHAR)

日期

活動的日期（採用排程單元的時區）。

欄位類型：日期

開始時間

活動的開始時間（採用排程單元的時區）。

欄位類型：時間 (9)

持續時間（秒）

活動的持續時間（秒）。

欄位類型：數字 (8,0)