資料提取 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 工作

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

POST作業

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

按作業 ID 取得作業

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

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

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

對於 POST 作業:

  • entityNameqm-workflows

  • 版本為:4

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

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

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

對於 POST 作業:

  • entityNameqm-questions

  • 版本是:2

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

CXone QM評估者備註和 CSV 檔案

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

對於 POST 作業:

  • entityName是:qm-evaluation-comment-entity

  • 版本是:1

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

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

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

對於 POST 作業:

  • entityNamerecording-interaction-metadata

  • 版本是:7

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

CXone WFM 工資單實體和 CSV 檔案

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

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

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