数据提取 API

通过数据提取 API,您可从 CXone Mpower 提取数据,以用于外部报告目的。 例如,您可以提取 QM 工作流数据、QM 问答数据、Recording 交互元数据或 WFM 工资单数据。 仅可根据指定的日期范围筛选数据。

您可以试用 Data 提取 API,并在 开发人员门户 中查看其文档。

调用 POST /jobs时,在准备数据时返回 jobId 。 您可以通过从终端节点 /jobs/{jobId}轮询服务来验证数据是否已准备就绪,该终端节点将返回作业的状态。 如果状态为成功,则还会返回其他 URL。 URL 的访问时间为 30 秒(不包括下载文件所需的时间)。

您可编写脚本,定期调用 API,而无需每次手动检索数据。 在任何给定时间,每位租户只有一个用户可以调用 API。 30 秒内仅可调用一次 API。

在您开始之前

可以在CXone Mpower开发人员门户 上测试 API。 使用CXone Mpower帐户登录,然后您可以使用帐户的租户关闭 高层级组织分组,用于管理 CXone Mpower 系统的技术支持、计费和全局设置。发出请求。

要开始使用 API,您必须向 NiCE 注册以接收用于身份验证的有效凭据。 有关说明,请查看开发人员门户上的入门页面

使用这些 API 需要以下权限:

  • 实体:

    • 如果您正在提取交互元数据,则需要搜索和播放 > API > 提取交互元数据权限。

    • 如果您正在提取QM 工作流数据,则您需要 QM 工具 > 数据提取 API > QM 工作流 API权限。

    • 如果您正在提取QM 问答数据,则您需要 QM 工具 > 数据提取 API > QM 工作流 API 权限。

    • 如果您正在提取 WFM 工资单数据,则您需要 WFM > 数据提取 API > WFM 工资单 API 权限。

    • 如果要提取QM评估员注释,则需要 QM 工具 > Data 提取 API > QM 评估员注释 API 权限。

获取工作

查看每位租户的所有作业状态列表。 可能的状态有正在运行成功失败已取消已过期

方法:获取

端点/data-extraction/v1/jobs

参数:无

准备作业

在发出提取数据的请求后,将收集数据并准备提取。 数据在 S3 中以 CSV 文件形式保存 24 小时。 完成后,返回作业 ID。

方法:POST

端点/data-extraction/v1/jobs

参数:无

按作业 ID 获取作业 ID

根据作业 ID 查看特定作业的状态。 如果作业成功,则将返回一个可访问提取数据的 URL,访问时间为 30 秒(不包括下载文件所需的时间)。 如果作业失败,则返回错误消息。 链接可以用于访问提取的数据。 可能的状态有正在运行成功失败已取消已过期

方法:获取

端点/data-extraction/v1/jobs

参数

jobId*

字符串

提取客户数据的请求的唯一标识符。

QM工作流实体和CSV文件

QM 工作流 API 可使您提取 QM 工作流数据,包括评估、自我评估和校准。

对于 POST 作业:

  • entityName 是:qm-workflows

  • version 是:4

根据 提交日期(采用 UTC 格式)筛选数据。

QM 问答 (Q&A) 实体和 CSV 文件

QM Q&A API 可使您从 QM 评估、自我评估和校准中提取数据。

对于 POST 作业:

  • entityName 是:qm-questions

  • version 是:2

根据 提交日期(采用 UTC 格式)筛选数据。

QM 评估员备注和 CSV 文件

QM 评估员备注 API 可使您提取 QM 评估员备注。

对于 POST 作业:

  • entityName 为:qm-evaluation-comment-entity

  • version 是:1

根据 提交日期(采用 UTC 格式)筛选数据。

交互元数据实体和 CSV 文件

交互元数据 API 可使您提取 Recording 交互元数据。

对于 POST 作业:

  • entityName 是:recording-interaction-metadata

  • 版本为:10

  • 要按日期和时间筛选数据,请使用 UTC 格式的 startDateendDate,格式为:yyyy-mm-dd hh:mm:ss

WFM 工资单实体和 CSV 文件

WFM 工资单 API(版本 1)允许您提取用于外部工资单报告目的的 WFM 活动数据。

POST 作业的 WFM 工资单实体名称是:wfm-payroll

数据工资单代码的日期进行筛选。 请记住,日期和时间的时区取决于调度单位的时区。