遮罩和取消遮罩 API

此API適用於具有語音或螢幕錄製功能的 Engagement Hub 使用者。如果您使用 CXone Mpower ACD，請參閱開發人員社群入口網站中的客服專員API 。

對於不使用公開遮罩 API 或需要容錯移轉解決方案的客戶，建議使用Data Policies中的Interactions Hub。 Data Policies 透過自動處理敏感資料來管理合規性和風險。這包括刪除包含敏感資訊的互動，例如 PCI 或侵犯隱私權。配置Data Policies作為維護資料隱私和安全的臨時或永久解決方案。

遮罩和取消遮罩 API 可在客服專員收集敏感資訊時遮罩語音錄音和螢幕錄影，然後解除遮罩錄製。對錄製遮罩和取消遮罩的功能可幫助組織保持符合隱私和 PCI 法規。這些 API 允許自動或手動對錄製遮罩和取消遮罩。您為特定使用者提交遮罩或取消遮罩請求。通話錄音中的遮罩片段故意靜音。這是應用遮罩時的預期行為，並不表示系統錯誤、呼叫保留或錄音失敗。播放器在遮罩處於活動狀態時提供視覺指示。

調用遮罩 API 會停止具有指定使用者 ID 的客服專員與每個通話參與者的語音錄音和螢幕錄影。

無論通話是否正在記錄，都可以請求 API 調用。如果通話未被錄製，則不會發生任何動作。可以訓練客服專員在收集敏感資料時始終遮罩通話，即使他們認為通話未被錄製。這是因為通話可能會在客服專員不知情的情況下從管理員發起的請求或客服專員的一個應用程式中被記錄下來。
如果客服專員與客戶進行了多個活動通話，API 調用會遮罩他們加入的最新通話。

調用取消遮罩 API 可恢復通話的語音和螢幕錄製。在下列情況下不會執行任何動作：

請求遮罩時通話未被記錄。
遮罩操作期間收到停止錄音事件。

遮罩和取消遮罩 API 的文件可在開發人員社群入口網站中找到。

開始之前

您可以在CXone Mpower開發者入口網站上測試API。使用CXone Mpower帳戶登入，然後您可以使用您帳戶的租戶用於管理CXone Mpower系統的技術支援、帳單和全域設定的高階組織群組。提出請求。

若要開始使用 API，您必須向 NiCE 註冊，以接收用於驗證的有效認證。查看開發人員入口網站上的開始使用頁面以取得說明。

使用這些 API 需要以下權限：

實體：要對錄製遮罩或取消遮罩，您需要搜尋及播放 > API >多個 ACD 遮罩 API 權限。

遮罩錄音

使用白色雜訊遮罩給定客服專員使用者 ID 的語音錄音和螢幕錄影。遮罩請求應與解除遮罩請求配對。

方法：POST

端點：/interaction-recording-management-service/v1/interactions/mask

參數：

userId*：

字串

要遮罩的客服專員的客服專員使用者 ID。

值和回應的範例

POST /interaction-recording-management-service/v1/interactions/mask?userId=12345

回應

狀態 200 - 操作成功。通話被遮罩。
狀態 202 - 操作處理序中。已接受遮罩請求，正在處理。
狀態 401 - 請求使用者驗證失敗。
狀態 403 - 請求使用者未獲授權執行操作。
狀態 404 - 未找到。未找到請求客服專員的活躍互動。
狀態：422-內部呼叫不支援操作。
狀態 425 - 處理先前的遮罩/取消遮罩請求時互動被鎖定。當服務忙於處理前一個請求時，無法處理遮罩請求。
狀態 500 - 內部伺服器錯誤。
狀態 504 - 請求逾時。

揭開錄音的面罩

取消給定客服專員使用者 ID 的語音和螢幕記錄遮罩。

方法：POST

端點：/interaction-recording-management-service/v1/interactions/unmask

參數：

userId*：

字串

要取消遮罩的客服專員的客服專員使用者 ID。

值和回應的範例

POST /interaction-recording-management-service/v1/interactions/unmask?userId=12345

回應

狀態 200 - 操作成功。通話正在解除遮罩。
狀態 202 - 操作處理序中。已接受解除遮罩請求，正在處理中。
狀態 401 - 請求使用者驗證失敗。
狀態 403 - 請求使用者未獲授權執行操作。
狀態 404 - 未找到。未找到請求客服專員的活躍互動。
狀態：422-內部呼叫不支援操作。
狀態 425 - 處理先前的遮罩/取消遮罩請求時互動被鎖定。當服務忙於處理前一個請求時，無法處理取消遮罩請求。
狀態 500 - 內部伺服器錯誤。
狀態 504 - 請求逾時。