按需錄製 API
此API適用於具有語音或螢幕錄製功能的 Engagement Hub 使用者。
這些 API 可啟動、停止和關閉按需錄製通話功能,從而透過 API 實現錄製控制。
「隨選記錄 API」的文件可在開發者社群入口網站
中找到。
開始之前
您可以在CXone Mpower開發者入口網站上測試
API。 使用CXone Mpower帳戶登入,然後您可以使用您帳戶的租戶
用於管理CXone Mpower系統的技術支援、帳單和全域設定的高階組織群組。提出請求。
若要開始使用 API,您必須向 NiCE 註冊,以接收用於驗證的有效認證。 查看開發人員入口網站上的開始使用頁面
以取得說明。
此外,使用此API需要 Interactions Hub >API > 多ACD按需記錄 API 權限。
開始隨選錄製
此 API 允許客服專員或應用程式開始錄製特定使用者正在進行的通話。 它可用於擷取與合規目的、品質保證或訓練相關的特定互動或對話。
您可以指定只開始錄製語音,或同時錄製語音和螢幕。 此 API 方法優先於錄製原則。
媒體類型標記是可選的,可控制錄製的媒體類型。 支援的值為語音和語音和螢幕,可讓您開始只錄製語音或同時錄製語音和螢幕。 如果未傳送此旗標,預設值會是語音。
方法:POST
端點: /interaction-recording-management-service/interactions/start-recording-on-demand
參數:
| userId*: |
字串 要錄製的媒體類型。 |
POST /interaction-recording-management-service/interactions/start-recording-on-demand?user-id=1234567
回應
-
狀態 200 - 操作成功。 開始按需錄製請求開始。
-
狀態 202 - 操作處理序中。 已接受按需開始請求,正在處理中。
-
狀態 400 - 請求錯誤
-
狀態 401 - 請求使用者驗證失敗。
-
狀態 403 - 請求使用者未獲授權執行操作。
-
狀態 404 - 未找到。 未找到活躍互動。
-
狀態 409 - 由於服務狀態,請求無法執行。
-
狀態 425 - 處理以前的按需記錄/按需停止請求時互動被鎖定
-
狀態 500 - 內部伺服器錯誤。
-
狀態 504 - 請求逾時。
停止錄製隨選
此 API 允許停止錄製特定使用者通話中的語音和螢幕。 它可用於保護客戶隱私,或遵守限制錄製特定類型對話的法規。
此 API 方法給予的優先次序高於Recording 原則。 Post 按需停止錄製 只有呼叫開始按需錄製才可恢復錄製。
方法:POST
端點:/interaction-recording-management-service/interactions/stop-recording-on-demand
參數:
| 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 - 請求逾時。
停用通話錄音選項
API 允許在客戶拒絕同意或不同意被錄製的情況下,停用錄製通話語音和螢幕的選項。 這與《通用資料保障條例》(GDPR) 尤其相關。 如果客戶拒絕同意,CXone Mpower Recording 將不會對通話進行錄音,即使為通話錄音設定了錄音原則,或者客服專員按需錄製通話,或使用 API。
整個客戶聯絡(包括轉移、諮詢和多方通話)都無法啟動透過 POST 進行 API 通話錄製。 如果在通話錄音過程中調用了 APIRecording 將停止錄音,但通話的已錄製部分將可用於搜尋和播放。
錄製同意僅適用於當前通話。 它不為客戶儲存以備將來的互動。
方法:POST
端點:/interaction-recording-management-service/interactions/do-not-record
參數:
| userId*: |
字串 要錄製的客服專員的客服專員使用者 ID。 |
POST /interaction-recording-management-service/interactions/do-not-record?user-id=1234567
回應
-
狀態 200 - 操作成功。 已啟動不錄製請求。
-
狀態 202 - 操作處理序中。 已接受不錄製請求,正在處理中。
-
狀態 400 - 請求錯誤。
-
狀態 401 - 請求使用者驗證失敗。
-
狀態 403 - 請求使用者未獲授權執行操作。
-
狀態 404 - 未找到。 未找到活躍互動。
-
狀態 409 - 由於服務狀態,請求無法執行。
-
狀態 425 — 處理先前的請求時,互動被鎖定。
-
狀態 500 - 內部伺服器錯誤。
-
狀態 504 - 請求逾時。