按需錄製 API

此 API 僅適用於 CXone Multi-ACD (CXone Open) 使用者。

這些 API 可啟動、停止和關閉按需錄製通話功能，從而透過 API 實現錄製控制。

開始之前

在開始使用遮罩和取消遮罩 API 之前，設定使用者權限、產生存取金鑰，並按照開發人員入口網站上說明的註冊和身份驗證過程進行操作。

此 API 需要搜尋和播放 >APIs > 多 ACD 按需錄製 API權限。

POST開始按需錄製

此 API 允許客服專員或應用程式開始錄製特定使用者正在進行的通話。 它可用於擷取與合規目的、品質保證或訓練相關的特定互動或對話。

您可以指定只開始錄製語音，或同時錄製語音和螢幕。 此 API 方法優先於錄製原則。

媒體類型標記是可選的，可控制錄製的媒體類型。 支援的值為語音和語音和螢幕，可讓您開始只錄製語音或同時錄製語音和螢幕。 如果未傳送此旗標，預設值會是語音。

userId*：

字串

要錄製的媒體類型。

POST /interaction-recording-management-service/interactions/start-recording-on-demand?user-id=1234567

回應

  • 狀態 200—操作成功。 開始按需錄製請求開始。

  • 狀態 202—操作執行中。 已接受按需開始請求，正在處理中。

  • 狀態 400—錯誤請求

  • 狀態 401—請求使用者驗證失敗。

  • 狀態 403—請求使用者未獲授權執行操作。

  • 狀態 404—未找到。 未找到活躍互動。

  • 狀態 409—由於服務狀態的關係，請求無法執行。

  • 狀態 425—在處理先前的按需錄製/按需停止請求時，互動被鎖定

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

  • 狀態 504—請求逾時。

POST按需停止錄製

此 API 允許停止錄製特定使用者通話中的語音和螢幕。 它可用於保護客戶隱私，或遵守限制錄製特定類型對話的法規。

此 API 方法優先於錄製原則。 Post 按需停止錄製 只有呼叫開始按需錄製才可恢復錄製。

userId*：

字串

要錄製的客服專員的客服專員使用者 ID。

POST /interaction-recording-management-service/interactions/stop-recording-on-demand?user-id=1234567

回應

  • 狀態 200—操作成功。 停止按需錄製請求開始。

  • 狀態 202—操作執行中。 已接受停止按需請求，正在處理中。

  • 狀態 400—錯誤請求。

  • 狀態 401—請求使用者驗證失敗。

  • 狀態 403—請求使用者未獲授權執行操作。

  • 狀態 404—未找到。 未找到活躍互動。

  • 狀態 409—由於服務狀態的關係，請求無法執行。

  • 狀態 425—在處理先前的按需錄製/按需停止請求時，互動被鎖定。

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

  • 狀態 504—請求逾時。

POST停用錄製通話的選項

API 允許在客戶拒絕同意或不同意被錄製的情況下，停用錄製通話語音和螢幕的選項。 這與《通用資料保障條例》(GDPR) 尤其相關。 如果客戶拒絕同意，則 CXone Recording 將不會錄製通話，即使錄製原則被設定為錄製通話，或如果客服專員按需或使用 API 錄製通話。

整個客戶聯絡（包括轉移、諮詢和多方通話）都無法啟動透過 POST 進行 API 通話錄製。 如果在進行通話錄製時調用 API，CXone Recording 將停止錄製，通話錄製部分將可供搜尋和回放。

錄製同意僅適用於當前通話。 它不為客戶儲存以備將來的互動。

userId*：

字串

要錄製的客服專員的客服專員使用者 ID。

POST /interaction-recording-management-service/interactions/do-not-record?user-id=1234567

回應

  • 狀態 200—操作成功。 已啟動不錄製請求。

  • 狀態 202—操作執行中。 已接受不錄製請求，正在處理中。

  • 狀態 400—錯誤請求。

  • 狀態 401—請求使用者驗證失敗。

  • 狀態 403—請求使用者未獲授權執行操作。

  • 狀態 404—未找到。 未找到活躍互動。

  • 狀態 409—由於服務狀態的關係，請求無法執行。

  • 狀態 425—在處理之前的請求時，互動被鎖定。

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

  • 狀態 504—請求逾時。