屏蔽和解除屏蔽 API

此 API 仅适用于 Multi-ACD (Open) 用户。 如果您使用的是 CXone Mpower ACD，请参阅开发者社区门户中的 Agent API。

对于不使用 Public Mask API 或需要故障转移解决方案的客户，建议Data Policies中的Interactions Hub。 Data Policies通过自动处理敏感数据来管理合规性和风险。 这包括删除包含敏感信息的交互，例如 PCI 或侵犯隐私的行为。 配置 Data Policies 可作为维护数据隐私和安全的临时或永久解决方案。

屏蔽和解除屏蔽 API 可以在坐席收集敏感信息时屏蔽语音和屏幕录制，然后解除录制屏蔽。 屏蔽录制和解除录制屏蔽的功能有助于组织遵守隐私和 PCI 法规。 这些 API 允许自动或手动屏蔽录制和解除录制屏蔽。 您为特定用户提交屏蔽或解除屏蔽请求。

对屏蔽 API 的调用会停止与具有指定用户 ID 的坐席进行呼叫的每个参与者的语音和屏幕录制。

  • 无论呼叫是否被录制，都可以请求 API 调用。 如果未对呼叫进行录制，则不会执行任何操作。 可培训坐席，使其在收集敏感数据时始终屏蔽呼叫，即使他们认为呼叫没有被录制也是如此。 这是因为在坐席不知情的情况下可从管理员发起的请求或坐席的一个应用程序录制呼叫。

  • 如果坐席正在参与和客户的多个活动呼叫，则 API 调用会屏蔽他们加入的最晚呼叫。

对解除屏蔽 API 的调用将恢复呼叫的语音和屏幕录制。 在以下情况时不会发生任何操作：

  • 在请求屏蔽时，呼叫未被录制。

  • 在屏蔽操作期间收到了停止录制事件。

如需屏蔽和解除屏蔽 API，请在开发者社区门户中获取。

有关域和 URL 的详细信息，请参阅开发者社区门户中的入门。

在您开始之前

在开始使用屏蔽和解除屏蔽 API 之前，必须设置用户权限、生成访问密钥，并遵循开发者门户上说明的注册和验证流程。 所需权限：

  • 实体：要屏蔽录制或解除录制屏蔽，您需要搜索和播放 > API > 多 ACD 屏蔽 API 权限。

POST 屏蔽

使用白噪声屏蔽给定坐席用户 ID 的语音和屏幕录制。 您应将屏蔽请求与解除屏蔽请求进行配对。

用户 ID*：

字符串

要屏蔽的坐席的坐席用户 ID。

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

应答

  • 状态 200 — 操作成功。 呼叫正被屏蔽。

  • 状态 202 — 操作进行中。 屏蔽请求已接受并正在处理。

  • 状态 401 — 发起请求的用户身份验证失败。

  • 状态 403 — 发起请求的用户无权执行该操作。

  • 状态 404 — 未找到。 未找到所请求的坐席的活动交互。

  • 状态：422—对于内部呼叫，不支持操作。

  • 状态 425 — 在处理先前的屏蔽/解除屏蔽请求时交互被锁定。 当该服务正忙于处理先前的请求时，无法处理屏蔽请求。

  • 状态 500 — 内部服务器错误。

  • 状态 504 — 请求超时。

POST 解除屏蔽

解除屏蔽给定坐席用户 ID 的语音和屏幕录制。

用户 ID*：

字符串

要解除屏蔽的坐席的坐席用户 ID。

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

应答

  • 状态 200 — 操作成功。 呼叫正被解除屏蔽。

  • 状态 202 — 操作进行中。 解除屏蔽请求已接受并正在处理。

  • 状态 401 — 发起请求的用户身份验证失败。

  • 状态 403 — 发起请求的用户无权执行该操作。

  • 状态 404 — 未找到。 未找到所请求的坐席的活动交互。

  • 状态：422—对于内部呼叫，不支持操作。

  • 状态 425 — 在处理先前的屏蔽/解除屏蔽请求时交互被锁定。 当该服务正忙于处理先前的请求时，无法处理解除屏蔽请求。

  • 状态 500 — 内部服务器错误。

  • 状态 504 — 请求超时。