按需录制 API
此 API 仅适用于 CXone Multi-ACD (CXone Open) 用户。
这些 API 可按需启动、停止和禁用呼叫记录,从而可通过 API 进行录制控制。
在您开始之前
在开始使用屏蔽和解除屏蔽 API 之前,设置用户权限、生成访问密钥,并遵循开发者门户上说明的注册和验证流程。
此 API 需要搜索和播放 > API > 多 ACD 点播记录 API 权限。
POST 按需开始录制
此 API 可使坐席或应用程序开始录制特定用户正在进行的呼叫。 它可用于捕获与合规性目的、质量保证或培训相关的特定交互或对话。
您可以指定仅开始录制语音,或同时开始录制语音和屏幕。 此 API 方法优先于录制策略。
mediaType 标志是可选的,其允许控制录制哪些媒体类型。 支持的值为 voice 和 voiceAndScreen,因此允许仅开始录制语音或同时录制语音和屏幕。 如果未传递该标志,则默认值将为 voice。
用户 ID*: |
字符串 要录制的媒体类型。 |
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 方法优先于录制策略。 停止按需录制后,只能通过调用开始按需录制来恢复录制。
用户 ID*: |
字符串 要录制的坐席的坐席用户 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 也是如此。
之后无法对整个客户联系(包括转移、咨询和会议)启动 API 呼叫记录。 如果在呼叫记录正在进行时调用此 API,则 CXone Recording 将停止录制,呼叫的已录制部分将可供搜索和播放。
录制同意仅适用于当前呼叫。 它不会为客户保存用于未来的交互。
用户 ID*: |
字符串 要录制的坐席的坐席用户 ID。 |
POST /interaction-recording-management-service/interactions/do-not-record?user-id=1234567
应答
-
状态 200 — 操作成功。 不记录请求已启动。
-
状态 202 — 操作进行中。 不记录请求已被接受并正在处理。
-
状态 400 - 错误请求。
-
状态 401 — 发起请求的用户身份验证失败。
-
状态 403 — 发起请求的用户无权执行该操作。
-
状态 404 — 未找到。 未发现活动交互。
-
状态 409 — 由于服务状态,该请求无法执行。
-
状态 425 — 在处理先前请求时交互被锁定。
-
状态 500 — 内部服务器错误。
-
状态 504 — 请求超时。