数据提取 API

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

数据提取 API 在 DEVone 开发者社区门户 中可用。

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

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

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

在您开始之前

在开始使用业务数据 API 之前，您必须设置用户权限，生成访问密钥，并遵循开发者门户上说明的注册和身份验证流程。所需权限：

  • 实体：

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

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

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

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

获取 作业

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

示例值

"jobs": [ { "id": "9dd92a83-1234-8549-8df4-939485722942", "status": "RUNNING" }, { "id": "12345d5h-c099-2345-k3r3-w3ko9ppp1234", "status": "FAILED" } ] }

响应

  • 状态 200 - 成功。检索所有作业的状态。

  • 状态 401 - 未经授权。无效凭据。

  • 状态 403 - 禁止。用户无权查看作业状态。

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

POST 作业

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

请求主体*: application/json

exportRequest {
描述：

 

为提取数据而需要提供的参数。
entityName

字符串

要提取的实体名称。有关正确的实体名称，请参阅下文。
版本

字符串

要提取的实体版本。有关各个实体的正确版本，请参阅下文。
startDate

string($date)

开始提取数据的日期（采用 UTC 格式）。日期格式为 <YYYY-MM-DD>。例如，要提取 2019 年 5 月 22 日的数据，请输入日期：2019-05-22。
endDate

string($date)

停止提取数据的日期（采用 UTC 格式）。日期格式为 <YYYY-MM-DD>。例如，要提取 2019 年 5 月 29 日的数据，请输入日期：2019-05-29。
}  

示例值

{ "entityName": "qm-workflows", "version": "3", "startDate": "2019-05-22", "endDate": "2019-05-29" }

响应

  • 状态 202 - 成功。已成功导出异步作业。

    字符串

    示例：12345d5h-c099-9303-j99j-w3ko9ppp1234

  • 状态 400 - 无效请求。不正确的日期筛选器等。

  • 状态 401 - 未经授权。无效凭据。

  • 状态 403 - 禁止。用户无权查看作业状态。

  • 状态 404 - 未找到。缺少实体或版本无效。

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

按作业 ID 获取作业

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

jobId*：

字符串

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

示例值

12345d5h-r3ds-9303-0pw3-w3ko9ppp1234

响应

  • 状态 202 - 成功。检索作业状态。

    jobResponse{ description: Displays the job status jobStatus: { description: Job Status, includes job ID and job status id: string Unique identifier of the job. status: string example: SUCCEEDED Job status that can be returned. Enum: [ RUNNING, SUCCEEDED, FAILED, CANCELLED, EXPIRED ] result: { description: Job result. If successful, contains the url, if failed, an error message is displayed. url: string example: https://s3.example.amazonaws.com/results-bucket/data-extraction/{details} A url to access the extracted data is returned when a job for extracting data is successful. errorMessage: string Error message displayed when a request for extracting data fails. } } }

  • 状态 400 - 无效请求。不正确的日期筛选器等。

  • 状态 401 - 未经授权。无效凭据。

  • 状态 403 - 禁止。用户无权查看作业状态。

  • 状态 404 - 未找到。缺少实体或版本无效。

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

CXone QM 工作流实体和 CSV 文件

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

对于 POST 作业：

  • entityName 是：qm-workflows

  • version 是：4

根据 提交日期（采用 UTC 格式）筛选数据。

列名称

说明

租户名称

租户的名称。

代理ID

坐席的唯一标识符。

字段类型：最多 36 个字符的字符串 (VARCHAR)

类型

评估类型，例如：

  • 评估

  • 自我评估

字段类型：最多 24 个字符的字符串 (VARCHAR)

评估流触发

启动评估的事件：

  • 校准

  • 协同

  • 手动

  • QP

字段类型：最多 24 个字符的字符串 (VARCHAR)

工作流状态

工作流的情况：

  • 发送至坐席

  • 正在审查

  • 争议

  • 已完成并确认

  • 已完成的自评

  • 已完成并通过审查

  • 已完成但未审查

  • 已完成

  • 已删除

  • 已删除 - 已完成

  • 已过期

  • 已删除 - 已过期

  • 已删除 — 已确认完成

  • 已删除 - 已审核完成

  • 已删除 — 已免审完成

字段类型：最多 128 个字符的字符串 (VARCHAR)

自动确认

可能的值包括：

  • TRUE：如果坐席未确认评估，评估将被自动确认。

  • FALSE：如果坐席确认了评估。

  • 空值：如果是自评，不需要进行确认。

字段类型：BOOLEAN

工作流状态

工作流的状态：

  • 打开

  • 关闭

  • 超时

字段类型：最多 128 个字符的字符串 (VARCHAR)

工作流 ID

评估的唯一标识符。

字段类型：最多 36 个字符的字符串 (VARCHAR)

API 版本：3 及更高版本

计划名称

用于发起评估的质量计划的名称

字段类型：最多 128 个字符的字符串 (VARCHAR)

表单名称

用于此评估的表单名称。

字段类型：最多 256 个字符的字符串 (VARCHAR)

表单版本

用于此评估的评估表的版本。

字段类型：数字 (4,0)

开始日期

开始此评估时的日期和时间 (UTC)。

字段类型：TIMESTAMP_LTZ(3)

提交日期

提交此评估时的日期和时间 (UTC)。

字段类型：TIMESTAMP_LTZ(3)

最后更新

上次修改此次评估的时间戳（采用 UTC 格式）。

字段类型：TIMESTAMP_LTZ(3)

分数 - 百分比

以百分比显示的评估分数。

字段类型：FLOAT

分数

评估分数。

字段类型：FLOAT

可能得到的最高分数

评估表中每一个问题可能得到的最高分数。

字段类型：FLOAT

级别

用户为定义表单等级而设置的自定义值范围。

字段类型：最多 256 个字符的字符串 (VARCHAR)

未通过的关键性问题

如果该值为真，则表明用户未能正确回答关键问题，且评估表单分数设置为零。

如果该值为假，则表明用户正确回答了问题。

字段类型：BOOLEAN

用户审核意见

用户（坐席）对评估提出异议时输入的意见。

字段类型：最多 256 个字符的字符串 (VARCHAR)

争议解决者意见

用户（经理/评估员）在结束争议时输入的意见。

字段类型：最多 256 个字符的字符串 (VARCHAR)

分段 ID

正在评估的交互的分段 ID。

字段类型：最多 36 个字符的字符串 (VARCHAR)

ACD ID

自动呼叫分配器的唯一标识符。

字段类型：NUMBER(38,0)

交互类型

交互的类型：

  • PHONE_CALL

  • 电子邮件

  • 聊天

  • 短信

  • 工作项目

  • GOOGLE_BUSINESS_MESSAGES_PRIVATE

  • APPLE_BUSINESS_CHAT_PRIVATE

  • TELEGRAM_PRIVATE

  • LINE_PRIVATE

  • WHATSAPP_PRIVATE

  • SLACK_PRIVATE

  • MICROSOFT_TEAMS_PRIVATE

  • TW_PRIVATE

  • VIBER_PRIVATE

  • CUSTOM_PRIVATE

  • WE_CHAT_PRIVATE

  • FB_PRIVATE

字段类型：最多 50 个字符的字符串 (VARCHAR)

交互开始日期

交互开始日期-时间（采用 UTC 格式）。

字段类型：TIMESTAMP_LTZ(6)

交互结束日期

交互的结束日期-时间（采用 UTC 格式）。

字段类型：TIMESTAMP_LTZ(6)

交互方向

呼叫方向：

  • 入站

  • 出站

字段类型：最多 50 个字符的字符串 (VARCHAR)

团队 ID

坐席所在团队的唯一标识符。

字段类型：最多 36 个字符的字符串 (VARCHAR)

团队名称

坐席所在团队的名称。

字段类型：最多 50 个字符的字符串 (VARCHAR)

电话号码

客户的电话号码。

字段类型：最多 200 个字符的字符串 (VARCHAR)

FirstName (Eva)

评估员的名字。

字段类型：最多 255 个字符的字符串 (VARCHAR)

LastName (Eva)

评估员的姓氏。

字段类型：最多 255 个字符的字符串 (VARCHAR)

FirstName (Agent)

所评估坐席的名字。

字段类型：最多 255 个字符的字符串 (VARCHAR)

LastName (Agent)

所评估坐席的姓氏。

字段类型：最多 255 个字符的字符串 (VARCHAR)

FirstName (Disp)

争议解决员的名字。

字段类型：最多 255 个字符的字符串 (VARCHAR)

LastName (Disp)

争议解决员的姓氏。

字段类型：最多 255 个字符的字符串 (VARCHAR)

FirstName (Assigner)

分配评估的用户的名字。

字段类型：最多 255 个字符的字符串 (VARCHAR)

LastName (Assigner)

分配评估的用户的姓氏。

字段类型：最多 255 个字符的字符串 (VARCHAR)
理由

删除评估的原因。

字段类型：最多 128 个字符的字符串 (VARCHAR)

API 版本：4 及更高版本
父 ID

评估的父工作流 ID，例如协作和校准。

字段类型：最多 36 个字符的字符串 (VARCHAR)

API 版本：4 及更高版本
评估主题

可能的值包括：

  • 员工

  • 片段

字段类型：最多 128 个字符的字符串 (VARCHAR)

API 版本：4 及更高版本

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

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

对于 POST 作业：

  • entityName 是：qm-questions

  • version 是：2

根据 提交日期（采用 UTC 格式）筛选数据。

列名称

说明

问题 ID

问题的唯一标识符。

字段类型：NUMBER(38,0)
问题标题

问题的正文。

字段类型：最多 2048 个字符的字符串 (VARCHAR)
问题编号

评估表单上的问题编号。

字段类型：最多 15 个字符的字符串 (VARCHAR)
回答

评估员对问题的回答。

字段类型：最多 10000 个字符的字符串 (VARCHAR)
选项

问题的可用答案选项，如是/否、数字选项、单选按钮选项等。

字段类型：ARRAY
表单 ID

评估表单的唯一标识符。

字段类型：最多 36 个字符的字符串 (VARCHAR)

表单名称

用于此评估的表单名称。

字段类型：最多 256 个字符的字符串 (VARCHAR)

表单版本

用于此评估的评估表的版本。

字段类型：NUMBER(4,0)
评估开始日期

开始此评估时的日期和时间 (UTC)。

字段类型：TIMESTAMP_LTZ(3)
评估提交日期

提交此评估时的日期和时间 (UTC)。

字段类型：TIMESTAMP_LTZ(3)

工作流类型

评估类型，例如：

  • 评估

  • 自我评估

字段类型：最多 24 个字符的字符串 (VARCHAR)
部分 ID 评估表单中部分的唯一标识符。

字段类型：NUMBER(38,0)
部分标题

评估表单中部分的名称。

字段类型：最多 2048 个字符的字符串 (VARCHAR)
可计分

判断该问题是否可以评分。

字段类型：BOOLEAN
实际分数

坐席在这个问题上能得到的分数。

字段类型：FLOAT
部分分数 (%)

问题所在部分的百分比分数。

字段类型：FLOAT
最高分数

坐席在这个问题上能得到的最高分。

字段类型：FLOAT

代理ID

坐席的唯一标识符。

字段类型：最多 36 个字符的字符串 (VARCHAR)

FirstName (Agent)

所评估坐席的名字。

字段类型：最多 255 个字符的字符串 (VARCHAR)

LastName (Agent)

所评估坐席的姓氏。

字段类型：最多 255 个字符的字符串 (VARCHAR)

团队 ID

坐席所在团队的唯一标识符。

字段类型：最多 36 个字符的字符串 (VARCHAR)

团队名称

坐席所在团队的名称。

字段类型：最多 50 个字符的字符串 (VARCHAR)

FirstName (Eva)

评估员的名字。

字段类型：最多 255 个字符的字符串 (VARCHAR)

LastName (Eva)

评估员的姓氏。

字段类型：最多 255 个字符的字符串 (VARCHAR)
关键

判断该问题是否为关键问题。

字段类型：BOOLEAN

未通过的关键性问题

如果该值为真，则表明用户未能正确回答关键问题，且评估表单分数设置为零。

如果该值为假，则表明用户正确回答了问题。

字段类型：BOOLEAN
强制性问题

判断该问题是否为必答问题。

字段类型：BOOLEAN
问题类型

问题的类型：

  • 无线电

  • 是/否

  • 复选框

  • 下拉菜单

  • 日期/时间

字段类型：最多 64 个字符的字符串 (VARCHAR)

分段 ID

正在评估的交互的分段 ID。

字段类型：最多 36 个字符的字符串 (VARCHAR)

交互开始日期

交互开始日期-时间（采用 UTC 格式）。

字段类型：TIMESTAMP_LTZ(6)

交互结束日期

交互的结束日期-时间（采用 UTC 格式）。

字段类型：TIMESTAMP_LTZ(6)

工作流实例 ID

评估的唯一标识符。

字段类型：最多 36 个字符的字符串 (VARCHAR)

评估分数 (%)

评估的百分比分数。

字段类型：FLOAT

题库 ID

问题所在问题库的唯一标识符。

字段类型：最多 36 个字符的字符串 (VARCHAR)
隐藏名称

真标志隐藏问题，假标志显示问题。在质量表单中使用 QM 表单规则时，它会根据前一个问题的分数隐藏后续问题。

字段类型：BOOLEAN

API 版本：2 及更高版本

CXone QM 评估员备注和 CSV 文件

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

对于 POST 作业：

  • entityName 为：qm-evaluation-comment-entity

  • version 是：1

根据 提交日期（采用 UTC 格式）筛选数据。

列名称

说明

评论 ID

评论的唯一标识符。

字段类型：最多 36 个字符的字符串 (VARCHAR)

多条评论

评论的文本。

字段类型：最多 300 个字符的字符串 (VARCHAR)

评论时间

添加评论的日期和时间。

字段类型：TIMESTAMP_LTZ(3)

活动

添加评论时的评估操作名称。

字段类型：最多 50 个字符的字符串 (VARCHAR)

评论者 ID

添加了评论的用户的唯一标识符。

字段类型：最多 36 个字符的字符串 (VARCHAR)

评论者名字

添加了评论的用户的名字。

字段类型：最多 255 个字符的字符串 (VARCHAR)

评论者姓氏

添加了评论的用户的姓氏。

字段类型：最多 255 个字符的字符串 (VARCHAR)

问题 ID

问题的唯一标识符。

字段类型：最多 36 个字符的字符串 (VARCHAR)

问题标题

问题的正文。

字段类型：最多 2048 个字符的字符串 (VARCHAR)

表单 ID

评估表达的唯一标识符。

字段类型：最多 36 个字符的字符串 (VARCHAR)

表单名称

用于此评估的表单的名称。

字段类型：最多 256 个字符的字符串 (VARCHAR)

表单版本

用于此评估的评估表单的版本。

字段类型：NUMBER(4,0)

工作流 ID

评估的唯一标识符。

字段类型：最多 36 个字符的字符串 (VARCHAR)

工作流状态

工作流的状态。

字段类型：最多 128 个字符的字符串 (VARCHAR)

代理ID

坐席的唯一标识符。

字段类型：最多 36 个字符的字符串 (VARCHAR)

FirstName (Agent)

坐席的名字。

字段类型：最多 255 个字符的字符串 (VARCHAR)

LastName (Agent)

坐席的姓氏。

字段类型：最多 255 个字符的字符串 (VARCHAR)

团队 ID

坐席所在团队的唯一标识符。

字段类型：最多 36 个字符的字符串 (VARCHAR)

团队名称

坐席所在团队的名称。

字段类型：最多 50 个字符的字符串 (VARCHAR)

交互元数据实体和 CSV 文件

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

对于 POST 作业：

  • entityName 是：recording-interaction-metadata

  • version 是：7

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

列名称

说明

ACD 呼叫 ID（如主联系人 ID）

ACD 呼叫 ID 取决于 ACD 解决方案，例如，与CXone主联系人 ID关闭 一个或多个相关联系人的主或父 ID。如果一个联系人已被转移 3 次或更多次，将分配一个新的主联系人 ID。 相同。

字段类型：最多包含 38 位数的数字

分段 ID

分段的唯一标识符。分段是指双方之间的交互，如客户和坐席。

字段类型：最多 36 个字符的字符串 (VARCHAR UUID)

分段开始的原因

分段开始的原因：

  • 多人

  • IVR

  • 分段：联系中的第一个分段

  • 转移

字段类型：最多 100 个字符的字符串 (VARCHAR)

分段结束原因

分段结束的原因：

  • 多人

  • IVR

  • 分段：联系中的最后一个分段

  • 转移

字段类型：最多 100 个字符的字符串 (VARCHAR)
方向

分段的方向：

  • 入站

  • 出站

  • 内部

  • 未知

字段类型：最多 150 个字符的字符串 (VARCHAR)

开始日期

分段的开始日期和时间（采用 UTC 格式）。

字段类型：TIMESTAMP

结束日期

分段的结束日期和时间（采用 UTC 格式）。

字段类型：TIMESTAMP
渠道类型

交互的类型：

  • 语音

  • 聊天

  • 电子邮件

  • IVR

  • 工作项目

  • 短信

  • 消息传递渠道：Facebook Messenger、Twitter 私信、WhatsApp、Apple Messages for Business、LINE Messaging、Telegram Messenger、Viber Messenger、Custom、Google Business Messenger、Microsoft Teams、Slack。

  • 公共社交渠道：Facebook、Google Places、Google Play、LinkedIn、Twitter、YouTube、Apple Apps Reviews、Custom（公共）。

字段类型：最多 150 个字符的字符串 (VARCHAR)
录屏

如果分段包括屏幕录制：

  • 是

  • 否
语音录制状态

录制的状态：

  • 成功

  • 部分录制：此分段的某些部分没有录制，但交互仍然可以回放

  • 与任何策略均不匹配：不录制—此交互未触发任何录制策略。

  • 由于录制 % 而未录制：不录制—此交互触发了录制策略，但因策略中定义的录制百分比而未录制

  • 不录制策略：不录制—此交互触发了不录制策略。

  • IVR 中已拒绝同意：无录制

  • 失败：无录制

  • 不适用：无录制 - 例如，数字交互或未设置为录制的历史交互

  • 屏蔽：无录制 - 录制被屏蔽

  • 记录传输至未选择的外部号码：无录制

  • 无录制，因为 mediaSourceType 为 NONE：无录制 — 未指定录制媒体

  • 未选择可以录制（语音）：无录制 — 未选择坐席属性可以录制（语音）

字段类型：最多 250 个字符的字符串 (VARCHAR)
屏幕录制状态

录制的状态：

  • 成功

  • 部分录制：此分段的某些部分没有录制，但交互仍然可以回放

  • 与任何策略均不匹配：不录制—此交互未触发任何录制策略。

  • 由于录制 % 而未录制：不录制—此交互触发了录制策略，但因策略中定义的录制百分比而未录制

  • 不录制策略：不录制—此交互触发了不录制策略。

  • IVR 中已拒绝同意：无录制

  • 失败：无录制

  • 不适用：无录制 - 例如，数字交互或未设置为录制的历史交互

  • 屏蔽：无录制 - 录制被屏蔽

  • 记录传输至未选择的外部号码：无录制

  • 无录制，因为 mediaSourceType 为 NONE：无录制 — 未指定录制媒体

  • 未选择可以录制（屏幕）：无录制 — 未选择坐席属性可以录制（屏幕）

字段类型：最多 250 个字符的字符串 (VARCHAR)

录制提醒

录制警报包括：

  • ScreenAgent 错误：有多种原因，例如坐席没有安装ScreenAgent关闭 NICE ScreenAgent 是一种服务，在需要屏幕录制的坐席桌面上运行。，或者ScreenAgent 错误。请参阅 解决 ScreenAgent 问题。

  • 未连接到媒体服务器：无录制。媒体服务器出现问题。原因可能有多种。录制提醒的错误描述提供了更详细的信息。

  • 语音录制器无法录制通话：无录制。语音录制器有问题。原因可能有多种。录制提醒的错误描述提供了更详细的信息。

  • 音频不可用：音频数据不完整：此交互不可用音频（不完整音频数据）。请联系 NICE CXone 支持团队。

  • 音频不可用：缺少音频数据包：音频对此交互不可用（缺少音频数据包）。请联系 NICE CXone 支持团队。

  • 音频不可用：缺少来自外部源的音频包：（CR 功能）音频对此交互不可用（媒体流中缺少音频包） 。请联系 NICE CXone 支持团队。

  • 系统错误：录制未开始或其他一般错误。请联系 NICE CXone 支持团队。

  • 通话时间太短：通话时间少于 4 秒，因此无法录制。

  • 屏蔽失败：屏蔽录音失败。您可以回放录制，检查是否有任何敏感数据。要删除录制，请单击操作操作按钮的屏幕截图 并选择删除录制。

  • 按需停止录制：由用户停止录制。

政策名称

应用于该交互的记录策略或不记录策略的名称。

字段类型：最多 100 个字符的字符串 (VARCHAR)
ANI

对于呼入呼叫，ANI 代表呼叫者的电话号码（呼叫者 ID）。

字段类型：最多 200 个字符的字符串 (VARCHAR)
DNIS

对于呼入呼叫，DNIS 代表被呼叫的电话号码（拨打号码）。

字段类型：最多 200 个字符的字符串 (VARCHAR)
ACW（以秒为单位）

呼叫结束后屏幕记录持续的秒数，以捕获坐席的呼叫后工作。
配置 标记坐席分配的关于呼叫的附加信息。
坐席用户 ID

分配给坐席的唯一标识符。

CSV 文件可包含最多 5 个坐席的坐席相关信息。

字段类型：最多 36 个字符的字符串 (VARCHAR)
坐席 ACD ID

ACD 分配给坐席的唯一标识符。

字段类型：最多 50 个字符的字符串 (VARCHAR)
坐席联系编号

分配给坐席的联系唯一标识符。

字段类型：最多包含 38 位数的数字

API 版本：5 及更高版本

座席员姓名

CXone 员工账户中指定的坐席姓名。

字段类型：最多 100 个字符的字符串 (VARCHAR)

坐席团队 ID

分配给坐席团队的唯一标识符。

字段类型：最多 36 个字符的字符串 (VARCHAR UUID)

坐席团队

坐席所在团队的名称。

字段类型：最多 40 个字符的字符串 (VARCHAR)

坐席员技能

在 ACD 中，根据能力、专业和知识分配给坐席的分类。

字段类型：最多 50 个字符的字符串 (VARCHAR)

相关联系人编号列表

与该分段关联的坐席的联系号码列表。该列表的元素仅为数字类型。

字段类型：变体

API 版本：7 及更高版本

交互 ID

交互的唯一 ID (UUID)。当有多个分段与单个交互关联时，这些分段可以具有相同的交互 ID。交互 ID 与分段 ID 或联系人 ID 不同。

字段类型：最多 36 个字符的字符串 (VARCHAR)

API 版本：7 及更高版本

业务数据名称

指定的业务数据字段的名称。

字段类型：最多 128 个字符的字符串 (VARCHAR)

API 版本：7 及更高版本

业务数据值

业务数据值可以是文本、数字或真/假。

字段类型：最多 4000 个字符的字符串 (VARCHAR)

API 版本：7 及更高版本

源

录音源 - CXone 或外部源。只有拥有 CXone AppLink 的用户才能使用这些值。

字段类型：最多 30 个字符的字符串 (VARCHAR)

API 版本：6 及更高版本

外部联系人 ID

录制的外部源中定义的联系人 ID。只有拥有 CXone AppLink 的用户才能使用这些值

字段类型：最多 100 个字符的字符串 (VARCHAR)

API 版本：6 及更高版本

外部段 ID

录制的外部源中定义的段 ID。只有拥有 CXone AppLink 的用户才能使用这些值

字段类型：最多 100 个字符的字符串 (VARCHAR)

API 版本：6 及更高版本

CXone WFM 工资单实体和 CSV 文件

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

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

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

列名称

说明

名

坐席的名字。

字段类型：最多 255 个字符的字符串 (VARCHAR)

姓

坐席的姓氏。

字段类型：最多 255 个字符的字符串 (VARCHAR)

用户名称

坐席的用户名。

字段类型：最多 255 个字符的字符串 (VARCHAR)

调度单元

坐席的调度单位。

字段类型：最多 256 个字符的字符串 (VARCHAR)

调度单位的时区

坐席的调度单位的时区。

字段类型：最多 128 个字符的字符串 (VARCHAR)

工资单代码

包含已计划活动数据的工资单代码。

字段类型：最多 50 个字符的字符串 (VARCHAR)

日期

活动的日期（在调度单位的时区中）。

字段类型：DATE

标准偏差

活动的开始时间（在调度单位的时区中）。

字段类型：TIME (9)

持续时间（以秒为单位）

活动的持续时间（以秒为单位）。

字段类型：NUMBER (8,0)