API 框架操作

API 框架操作是允许您在脚本中使用 CXone API 的 Studio 操作。您可以使用该操作,而不是使用传统集成方法调用 API,例如使用代码片段或 RestAPI 操作。API 操作均位于 Studio 中的框架选项卡上。

API 操作与标准 Studio 操作不同。目前,联机帮助中尚未记录此类操作。不过,与 API 操作相对应的 API 在 CXone 开发者门户 一个方块,箭头从中心指向右上角。中有文档说明。在脚本中使用 API 操作时,您可以使用此文档。

并非每个 CXone API 在Studio 中均有相对应的 API 操作。

API 操作需要安全用户。您可以使用 SETSECURITYUSER 操作在脚本中设置安全用户

API 操作版本

随着 CXone API 的新版本的发布,Studio 中可能会发布相对应操作的新版本。一般来说,最好使用最新版本的操作。旧版本在大多数情况下仍然有效。您可以尝试不同的版本,看看哪些版本有效并提供您需要的功能。

某些 API 操作的操作名称中包含版本号。查看“框架”选项卡上的操作树结构时,即可看到它。并非所有 API 操作均包含版本号。对于这些操作,您可以在其扩展属性中找到版本号。仅当在“框架”选项卡中选择操作时,您才能在“属性”选项卡上看到扩展属性。

并非每个 API 的每个版本在Studio 中都有相对应的操作。

查看 API 操作扩展属性

  1. Studio 中,重新排列选项卡,这样您就可以同时看到“属性”选项卡和“框架”选项卡。
  2. 在“框架”选项卡上,单击 API 操作。
  3. 在“属性”选项卡上,现在即可看到该操作的扩展属性。在了解 API 操作时,以下属性尤其有用:
    • 其他 > 参数 > 动词:该属性显示与操作相关联的方法或动词。
    • 其他 > 参数 > 版本:该属性显示 API 的版本。
    • 其他 > Web > URI:在开发者门户中查找 API 文档时,该属性很有用。
    • 其他 > 参数:在“参数”部分,您可以展开属性,查看有关每个操作属性的附加信息。

查找 API 文档

CXone API 记录在 CXone 开发者门户中。Studio 中的 API操作没有与其 API 相对应文档的直接链接。不过,您可以使用该操作的扩展属性中提供的信息来帮助您查找文档。

使用此 URI 需要大致熟悉整个 CXone 系统以及不同的 CXone API。这是因为确定哪个 API 与 Studio 中的操作相匹配并不总是很简单。了解联系人通过 CXone 的一般流程有助于您正确解释操作的 URI,以及将在那里找到的线索应用于开发者门户中的 API 文档结构。本部分中的示例演示了可能需要的解释。

开发者门户 API 部分的主页提供了每个 CXone API 的概述

示例 1

有时,操作与其 API 之间存在直接关联:

根据操作的名称和 URI,首先要考虑的两个 API 是 Agent APIAdmin API。通过查看每个 API 的调用列表,您可以排除 Agent API。其描述表明它用于管理坐席会话,但似乎没有任何与技能相关的调用,如下图所示。

Admin API 表明它与技能等系统对象一起使用。该 API 可用的 API 调用列表包括技能,如下图所示。

展开“技能”部分时,端点之一为 GET /skills/agents。该端点的简短描述称其“返回技能分配”。

示例 2

有时,相关性并不明显,如下例所示。在这种情况下,您需要应用 CXone API 和平台本身的知识来查找相应的 API 端点。—

根据该操作的名称和 URI,并不能立即看出首先要查看哪个 API。如果您不确定从哪里开始,可以查看每个 API 的文档并检查与联系人相关的任何部分。Admin API 是唯一具有顶层联系人部分的 API。遗憾的是,该 API 不包含与活动联系人相关联的端点。

此时,您可以在操作名称和 URI 中键入单词 active。根据您对 CXone 的了解,您知道活动表示当前正在处理的联系人。这会让您更仔细地研究“实时数据 API”。该 API 只有一个部分,将其展开时,您会看到其中一个端点为 GET /contacts/active。该端点的简短描述称其“返回活动联系人”。