屏幕交互录制 API

API 可用于发起桌面活动的屏幕录制。 这能够实现无联系时记录坐席的屏幕以及后台屏幕的录制。

此 API 可供 Multi-ACD (Open) 和 CXone MpowerACD 用户使用。

在您开始之前

在开始使用这些 API 之前，请设置用户权限、生成访问密钥并遵循开发者门户上说明的注册和身份验证流程。

这些 API 需要交互中心录制屏幕交互权限。

POST开始屏幕交互录制

该 API 可为未处于活动呼叫中的特定用户启动屏幕录制。 您必须通过将录制持续时间作为参数在启动命令中提供来指定。 持续时间应在 5 秒到 3:30 小时（允许的最长时间）之间。 当达到持续时间时，录制将自动停止。 此外，您可以通过调用 stop-screen-interaction-recording 命令停止屏幕录制。

  • 当启动录制（由响应代码 202 指示）或成功（由响应代码 200 指示）时，将提供与所录制的屏幕相关联的联系人 ID。 发出停止命令时应使用此联系人 ID。

  • 该 API 可以在坐席与客户之间的实时呼叫期间使用，这可能会被录制。 在这种情况下，将有两个不同的录音 - 一个捕获语音对话，另一个基于 API 交互 - 每个录音都与不同的联系人 ID 相关联。

  • 如果将屏蔽应用于实时呼叫，它还会影响可能并行录制的 API 屏幕录制交互。

  • 使用 API 时，可以有单个屏幕录制实例。 如果已通过 API 录制坐席的屏幕，则对该同一坐席的任何后续 API 调用都不会生成新的屏幕录制，也不会更新录制持续时间。

用户 ID*：

字符串

被记录的用户ID。
录制持续时间*：

号码

指定所需的录制持续时间，范围为 5-13200 秒

示例 POST /交互-录制-管理-服务/交互/开始-屏幕-交互-录制？user-id = 1234567&recordingDuration = 3000

响应

  • 状态 200 — 操作成功。

    contactId（数字）：ACD 联系人 ID

    交互Id（字符串）：全局交互 ID

  • 状态 202 — 操作正在进行中。

    contactId（数字）：ACD 联系人 ID

    交互Id（字符串）：全局交互 ID

  • 状态 400 - 错误请求。

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

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

  • 状态 404 — 未找到。 未发现活动交互。

  • 状态 425 — 在处理先前请求时交互被锁定。

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

  • 状态 504 — 请求超时。

POST 停止屏幕交互录制

该 API 能够停止使用 start-screen-interaction-recording 命令启动的特定用户的联系人 ID 的屏幕录制。 您应使用 start-screen-interaction-recording 命令的响应中提供的联系人 ID。 如果未调用此方法，则屏幕录制将在 start-screen-interaction-recording 命令中提供的持续时间后自动停止。

用户 ID*：

字符串

要停止的录制用户的 ID。
contactId*：

号码

“开始屏幕录制”命令中返回的联系人 ID。

示例 POST /交互-录制-管理-服务/交互/停止屏幕交互-录制？user-id=1234567&contactId=1122334455

响应

  • 状态 200 — 操作成功。

  • 状态 202 — 操作正在进行中。

  • 状态 400 - 错误请求。

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

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

  • 状态 404 — 未找到。 未发现活动交互。

  • 状态 425 — 在处理先前请求时交互被锁定。

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

  • 状态 504 — 请求超时。