自定义虚拟坐席集成示例

NICE CXone 开发了一个示例代理隧道供您使用。您可以设置此示例自定义集成，以更好地了解自定义集成的工作原理。此示例使用 CXone ACD 聊天模拟自定义文本虚拟坐席集成。

本例中的示例代码与实际集成中使用的代理隧道不同。在实际集成中，代理隧道被设置为与虚拟坐席的端点进行通信。示例代码不与实际的虚拟坐席进行通信。相反，它被配置为回传测试用户的输入。因此，如果您在测试窗口中输入 Hello chatbot，则回复为 Hello chatbot。

要设置示例集成，您必须在您的环境中下载并安装示例代理代码。代理隧道示例可使用多种不同的编程语言。您的团队可以使用他们最熟悉的语言。

自定义虚拟坐席集成模板技术设计文档 (TDD) 包括基于此示例集成的示例。TDD 模板中的示例有助于您更好地了解自定义虚拟坐席集成。

本页面上的某些链接可打开 CXone 联机帮助之外的站点。

要求

要测试示例集成，您必须：

  • 在计算机上安装Studio 。
  • 下载示例代码 ZIP 文件。示例代码有以下语言版本：
    • C# .NET
    • Java
    • Node.js
    • PHP
    • Python
  • 您所使用的示例代码的语言的 IDE 和编译器依赖关系：
    • C# .NET：VS代码或其他代码编辑器。
    • Java：VS Code Community、Jet Brains、Net Beans、Intelli J、Eclipse 或其他。如果使用 VS Code 编辑器，则需要从 Visual Studio Marketplace 网站下载并安装Java 扩展包。
    • Node.js：NPM.
    • PHP：VS Code 或其他代码编辑器。
    • Python：VSCode 或其他代码编辑器。
  • 在计算机上安装 Ngrok。您可以在此站点上找到安装方法：https://ngrok.com/download。

按照给定的顺序完成以下每一个任务。

设置代理隧道端点

在本地主机端口上运行此 API 调用。复制运行该服务的端口号。您将在后面的步骤中需要该号码。单击下拉列表，查看为每种可用语言设置端点的说明。

  1. 提取 ProxyTunnelExamples.zip 文件的内容。

  2. 在代码编辑器中，导航到提取的文件中包含 C# 代理隧道代码的文件夹。

    cd ProxyTunnel/examples/c#/ProxyTunnel

  3. 打开 Program.cs 文件。该文件包含代码。

  4. 打开 Powershell 并运行以下命令：

    dotnet run

  5. 记住运行服务的端口号。在以下示例图像中，它在端口 8080 上运行。

您可以使用代码编辑器设置代理隧道端点。如果您没有 Java 代码编辑器，则可以使用 Apache Maven 等实用程序，它允许您运行 Java 文件。此处描述了这两种方法。

使用代码编辑器

如果使用 VS Code 编辑器，则需要从 Visual Studio Marketplace 网站下载并安装Java 扩展包。此扩展包将 Run | Debug 选项置于主函数之上。

  1. 从 ProxyTunnelExamples.zip 文件中提取内容。
  2. 在代码编辑器中，打开包含 Java 代理隧道代码的文件夹。Java 代理隧道代码的路径为：

    ProxyTunnel\examples\java\src\main\java\com\icx\javaproxytunnel

  3. 使用主函数顶部显示的运行按钮运行端点。它看起来如下所示：

    VS Code 编辑器中的 Java 代理隧道代码显示 main 函数：public static voice main (String[] args) 上方的 Run | Debug 选项。

  4. 应用程序已初始化。请注意终端输出顶部的端口。在下图中，端口为 8080。

    Java 的终端输出显示代理隧道正在运行的端口 8080 (http)。

使用 Java 实用程序

  1. 安装以下实用程序：
  2. 设置本地运行 Java 程序所需的环境变量：
    1. 在计算机上搜索高级系统设置或环境变量。
    2. 在系统属性窗口的高级选项卡上，单击环境变量。
    3. 在系统变量部分中，选择路径，然后单击 编辑。

    4. 浏览到每个实用程序的安装位置，为 Maven 和 Java bin 文件夹创建两个新路径。例如，路径可能为：

      C:\Program Files\apache-maven-3,8,6-bin\apache-maven-3.8.6\bin

      C:\Program Files\Java\jdk-18.0.2\bin

  3. 从 ProxyTunnelExamples.zip 文件中提取内容。

  4. 安装应用程序：

    1. 打开 Powershell 或命令提示符，并将目录更改为包含该应用程序的文件夹。例如：

      cd ProxyTunnel\examples\Java

    2. 运行以下命令，编译该应用程序并将其转换为 Maven 程序包：

      mvn compile
      mvn package

      这会在名为 \target 的目录下生成一个 JAR 文件。

    3. 运行生成的 JAR 文件。

      java -jar target/javaproxytunnel-0.0.1-SNAPSHOT.jar

    4. 记下命令提示符窗口中初始化输出的端口号。在以下示例中，端口为 8080。

      以及运行生成的 JAR 文件的结果示例。它显示要使用的端口号。

完成此任务前，请确保已在计算机上安装节点和 NPM。

  1. 从 ProxyTunnelExamples.zip 文件中提取内容。

  2. 打开命令提示符或 PowerShell 并更改为 Node.js 文件的位置。

    cd ProxyTunnel/examples/Nodejs

  3. 从 Nodejs 代码文件夹运行以下命令：

    npm install

  4. 运行端点。使用您所使用操作系统的命令。

    Linux：

    export DEBUG='javascriptechoproxy:server'
    npm run start

    使用 powershell 的 Windows：

    npm run devstart

  5. 记下命令提示符窗口中初始化输出的端口号。例如，它可能是 8080。

您需要在计算机上安装 PHP 才能使用此选项。如果尚未安装 PHP，有两种安装方法：

  • 使用软件管理工具 Chocolatey。这是首选方案。要使用 Chocolatey 安装 PHP，请以管理员身份打开 Powershell 并输入以下命令：

    choco install php

  • 直接从 Windows PHP 网站安装 PHP。

安装 PHP 后，请按照以下步骤设置代理隧道端点：

  1. 从 ProxyTunnel_PHP.zip 文件中提取内容。

  2. 使用命令提示符或 PowerShell 切换到 \PHP 文件夹。

    cd ProxyTunnel/examples/php

  3. 从 PHP 文件夹运行此命令：

    php -S localhost:8000

    该应用程序已初始化并在端口 8000 上运行。记住该端口号，以便在稍后的设置过程中使用。

  1. 从 ProxyTunnelExamples.zip 文件中提取内容。

  2. 在代码编辑器中，打开代理隧道 Python 文件夹。
  3. 使用代码编辑器控制台切换到包含 API 文件的文件夹。

  4. 在代码编辑器的终端窗格中或使用命令提示符，使用以下命令在系统上安装 Flask：

    pip install flask

  5. 使用此命令运行代理隧道：

    python echo-proxy-tunnel.py

    记下终端窗口中初始化输出的端口号。记住该端口号，以便在稍后的设置过程中使用。在以下示例图像中，端口为 5000。

    在 Python 中运行代理隧道的输出示例。本示例中的端口号为 5000。

公开代理隧道端点

代理隧道端点必须公开，以便 CXone 可以全局访问它。使用 Ngrok 公开端点。

  1. 安装 Ngrok（如果尚未安装）。

  2. 从命令提示符处使用以下命令启动 Ngrok：

    ngrok http [port number]

    其中[端口号]是您在设置端点时记下的端口号。

  3. 复制 Ngrok 公开的服务器 URL 和所需的 API 端点。

    在代理隧道端点上运行 Ngrok 的结果示例，显示了作为结果公开的 URL。

    在示例图像中，公开的 URL 为https://4db3-5-46-62-207.nrgok.io。这是 Webhook 的基本 URL。确定与 URL 一起使用的端点。保存 URL，以便在稍后的任务中配置文本机器人 Studio 操作时使用。

    语言 端点详细信息
    C#

    服务器以 POST proxy/performbotexchange 方法接受 虚拟坐席中心 请求。您的 Webhook URL 为：

    https://[base URL]/proxy/performbotexchange
    Java

    服务器以 POST api/proxy 方法接受 虚拟坐席中心 请求。您的 Webhook URL 为：

    https://[base URL]/api/proxy
    Node.js

    服务器以 POST api/relay 方法接受 虚拟坐席中心 请求。您的 Webhook URL 为：

    https://[base URL]/api/relay
    Python

    服务器以 POST relayExchangeResponse 方法接受 虚拟坐席中心 请求。您的 Webhook URL 为：

    https://[base URL]/relayExchangeResponse
    PHP

    服务器以 POST proxy.php 方法接受 虚拟坐席中心 请求。您的 Webhook URL 为：

    https://[base URL]/proxy.php

本节中描述的确定端点的步骤仅适用于示例集成。创建自己的端点时，它可以是满足您组织需求的任何端点。

在 Studio 中设置简单的聊天脚本

  1. 下载这个简单的聊天脚本。
  2. 将 TextBotExchangeExample.xml 文件提取到您的计算机中。
  3. 在 Studio 中，单击文件 > 从文件导入，选择提取后的文件，然后单击打开。
  4. 保存脚本。记下为脚本指定的名称。让脚本保持打开状态。您将在稍后的任务中返回它。

在 CXone 中创建聊天技能和联络点

您需要创建聊天技能关闭 用于根据坐席的技能、能力和知识自动传递交互和联络点关闭 呼入联系人用来发起交互的入口点，如电话号码或电子邮件地址。。联络点调用您导入的脚本。这就是 CXone 将联系人路由至虚拟坐席的方式。

  1. 在 CXone 中单击应用程序选择器 并选择ACD。
  2. 单击联系人设置 > ACD 技能和创建聊天技能。您必须为技能指定名称并将其分配给营销活动。您可能想要创建一个用于示例集成的营销活动。您可以接受所有其他技能选项的默认值。

  3. 转至联系人设置 > 联络点，然后按以下设置创建联络点：

    • 媒体类型：选择聊天。
    • 脚本：选择要与示例集成一起使用的导入脚本名称。
    • 技能：选择您在此任务中创建的技能的名称。

  4. 创建联络点后，复制详细信息选项卡上显示的联络点 URL。将其粘贴到浏览器的选项卡中。您将在稍后的任务中使用此 URL 来测试脚本。

    创建用于测试示例代理隧道的联系人的详细信息选项卡。联络点字段显示调用脚本的 URL。

配置 Textbot Exchange 操作

此步骤配置 CXone，以便与示例代理隧道端点进行通信。

  1. 在 Studio 中，打开导入的示例脚本（如果尚未打开）。

  2. 双击 Textbot Exchange 操作之一打开 虚拟坐席中心。

    Textbot Exchange 操作的图标。这是一个聊天气泡，里面有一双机器人的眼睛，上面有一根天线，下面有 ABC 字样。
  3. 单击添加机器人。
  4. 输入虚拟坐席（机器人）名称，然后选择自定义交换端点作为机器人提供程序。
  5. 单击下一步。
  6. 输入 Webhook URL。这是您在公开代理隧道端点后保存的 URL。
  7. 单击下一步。
  8. 在语音页面上，选择语音集成选项下的纯文本，然后单击下一步。
  9. 在测试 + 添加页面上，单击以欢迎意图开始。测试其他选项，例如根据需要发送自定义负载。如果没有错误，则继续下一项任务。如果测试结果出错，请查看前面的任务，以验证代理隧道端点的设置和公开，以及 虚拟坐席中心 中的配置。

从聊天窗口测试脚本

解决了测试 Textbot Exchange 操作配置时发生的任何错误后，您可以使用在上一个任务中复制的联络点关闭 呼入联系人用来发起交互的入口点，如电话号码或电子邮件地址。 URL 测试脚本。

  1. 在 Studio 中，打开导入的示例脚本。
  2. 单击调试 > 捕获脚本 > 仅下一个实例。
  3. 在粘贴联络点 URL 的浏览器选项卡中，在 输入您的文本 字段中键入消息，然后单击发​​送。

  4. 在 Studio 中，“跟踪输出”窗口随即打开。发送消息和脚本响应时，它会显示脚本的进度。

    单击 Trace Output 窗口主窗格中的操作。

    • “变量”选项卡显示所选操作完成后存在于脚本中的所有变量。它还显示脚本中每个变量在该点所保存的值。
    • “属性”选项卡显示所选操作的属性。您可以使用它来验证操作的当前配置。
    Studio 中的“跟踪输出”窗口，显示从示例聊天虚拟坐席脚本开始的跟踪结果。
  5. 如有必要，返回脚本并进行更改。
  6. 要访问某个操作的联机帮助，请在画布上选择该操作，然后按下键盘上的 F1。每个操作的联机帮助页面描述了有关在脚本中使用该操作的属性和其他信息。
  7. 如果要重新开始，请单击结束聊天，刷新浏览器窗口，然后从步骤 2 开始重复此过程。