自訂虛擬客服專員整合範例

NICE CXone 開發了可供您使用的代理隧道的範例。您可以設定此自訂整合的範例，以便更好地了解自訂整合的工作方式。此範例模擬了使用 CXoneACD 聊天的自訂文字虛擬客服專員整合。

本例中的範例代碼與實際整合中使用的代理隧道不同。在實際整合中，設定客服專員隧道以與虛擬客服專員的終點進行通訊。此樣本代碼無法與實際的虛擬客服專員進行通訊。相反，它被配置為回傳測試它的使用者的輸入。因此，如果您在測試視窗中輸入 Hello chatbot，回覆為 Hello chatbot。

要設定整合的範例，您必須在您的環境中下載並安裝樣本代理代碼。代理隧道範例可用於幾種不同的程式設計語言。您的團隊可以使用他們工作時最熟悉的語言。

自訂虛擬客服專員整合的範本技術設計文件 (TDD) 包括基於此整合實例的範例。TDD 範本中的範例可以協助您更好地了解自訂虛擬客服專員整合。

本頁的一些連結將會開啟 CXone 線上說明以外的網站。

要求

要測試整合範例，您必須：

  • Studio 已安裝在您的電腦中。
  • 已下載樣本代碼 ZIP 檔案。範例代碼有以下語言版本：
    • C# .NET
    • Java
    • Node.js
    • PHP
    • Python
  • 您所使用的樣本代碼的語言的 IDE 和編譯器依賴性：
    • C# .NET：VS Code 或其他代碼編輯器。
    • Java：VS Code Community、Jet Brains、Net Beans、Intelli J、Eclipse 或其他。如果您使用 VS Code 編輯器，您需要從 Visual Studio Marketplace 網站下載並安裝 Java Extension pack。
    • 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 Extension pack。此擴展包在主函數上方放置了 Run | Debug 選項。

  1. 提取 ProxyTunnelExamples.zip 檔案中的內容。
  2. 在您的代碼編輯器中，開啟包含 Java 代理隧道代碼的資料夾。Java 代理隧道代碼的路徑為：

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

  3. 使用主函數頂部顯示的運行按鈕運行終點。如下所示：

    在 VS Code 編輯器中的 Java 代理隧道代碼顯示主函數上方的 Run | Debug 選項：public static voice main (String[] args)。

  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 或 Command Prompt，將目錄改為包含應用程式的資料夾。例如：

      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. 開啟 Command Prompt 或 PowerShell，變更 Node.js 檔案的位置。

    cd ProxyTunnel/examples/Nodejs

  3. 運行來自 Nodejs 代碼資料夾的命令：

    npm install

  4. 運行終點。使用您所使用的作業系統的命令。

    Linux：

    export DEBUG='javascriptechoproxy:server'
    npm run start

    使用 powerhell 的 Windows：

    npm run devstart

  5. 注意命令提示視窗中初始化輸出的通訊埠號。例如，它可能是 8080。

您需要在您的電腦上安裝 PHP 才能使用此選項。如果您還未安裝 PHP，安裝 PHP 有兩個選項：

  • 使用 Chocolatey，這是一個軟體管理工具。這是首選方案。要用 Chocolatey 安裝 PHP，以管理員身份開啟 Powershell 並輸入此命令：

    choco install php

  • 直接從 Windows 的 PHP 網站安裝 PHP。

安裝 PHP 後，按照以下步驟設定代理隧道終點：

  1. 提取 ProxyTunnel_PHP.zip 檔案中的內容。

  2. 使用 Command Prompt 或 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]

    其中 [port number] 是您在設定終點時寫下的通訊埠號。

  3. 複製公開 Ngrok 的伺服器 URL 和所需的 API 終點。

    在代理隧道終點上運行 Ngrok 的結果範例，顯示作為結果公開的 URL。

    在範例圖像中，公開的 URL 為 https://4db3-5-46-62-207.nrgok.io。這是 Webhook 的基本 URL。確定要與您的 URL 一起使用的終點。儲存 URL，以便在以後的任務中配置 textbot Studio 動作時使用。

    語言 終點詳情
    C#

    伺服器接受在 POST proxy/performbotexchange 方法處的 虛擬客服專員中心 請求。您的 Webhook URL 為：

    https://[基礎 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 中，建立聊天技能和聯絡點。

您需要建立聊天技能Closed 用於基於客服專員技能、能力和知識的互動的自動化傳遞和聯絡點Closed 呼入聯絡人用來發起互動的入口點，如電話號碼或電郵地址。。聯絡點調用您匯入的指令碼。這就是 CXone 如何將聯絡路由到您的虛擬客服專員。

  1. 在 CXone 中，點擊應用程式選擇器 並選擇ACD。
  2. 點擊 聯絡設定 > ACD 技能和建立聊天技能。您必須指定技能的名稱並將其指派給活動。您可能想要建立活動以進行樣本整合。您可以接受所有其他技能選項的預設值。

  3. 前往聯絡設定 > 聯絡點和建立聯絡點，設定如下：

    • 媒體類型：選擇聊天。
    • 指令碼：選擇您匯入的指令碼的名稱，以便與範例整合使用。
    • 技能：選擇您在此任務中建立的技能名稱。

  4. 建立聯絡點後，複製「詳情」標籤上顯示的聯絡點 URL。將其貼上瀏覽器的標籤中。您將在以後的任務中使用此 URL 測試指令碼。

    為測試樣本代理隧道而建立的聯絡點的「詳情」標籤。「聯絡點」欄位顯示叫用指令碼的 URL。

配置 Textbot Exchange 動作

此步驟配置 CXone 以與樣本代理隧道終點通訊。

  1. 在 Studio 中，開啟您匯入的樣本指令碼，如果它還未開啟。

  2. 點擊兩下其中一個 Textbot Exchange 行動以開啟 虛擬客服專員中心。

    Textbot Exchange 動作的圖示。這是一個聊天泡泡，裡面有雙機器人的眼睛，上面有一根天線，天線下面有字母 ABC。
  3. 點擊新增機器人。
  4. 輸入虛擬客服專員（機器人）名稱，然後選擇 Custom Exchange Endpoint 作為機器人提供者。
  5. 點擊下一步。
  6. 輸入您的 Webhook URL。這是您在公開代理隧道終點後儲存的 URL。
  7. 點擊下一步。
  8. 在「語音」頁面，選擇語音整合選項下的僅文字，然後點擊下一步。
  9. 在「測試 + 新增」頁面，點擊從歡迎意圖開始。測試其他選項，如根據需要，傳送自訂工作負載。如果沒有錯誤，繼續下一個任務。如果測試結果是錯誤的、檢閱以前的任務以驗證代理隧道終點的設定和公開以及虛擬客服專員中心中的配置。

從聊天視窗測試指令碼

當您解決了在測試Textbot Exchange動作的配置時發生的任何錯誤，您可以使用之前的任務中複製的聯絡點Closed 呼入聯絡人用來發起互動的入口點，如電話號碼或電郵地址。 URL 測試指令碼。

  1. 在 Studio 中，開啟您匯入的樣本指令碼。
  2. 點擊偵錯 > 擷取指令碼 > 僅下一個執行個體。
  3. 在您貼上聯絡點 URL 的瀏覽器標籤中，在輸入您的文字欄位中鍵入訊息並點擊傳送。

  4. 在 Studio 中，開啟「追蹤輸出」視窗。當您傳送訊息和指令碼回應時，它將顯示指令碼的進度。

    點擊 Trace Output 視窗中主窗格中的動作。

    • 「變數」標籤顯示了所選動作完成時指令碼中存在的所有變數。其還顯示了指令碼中在該點保持的每個變數的值。
    • 「屬性」標籤向您顯示了所選動作的屬性。您可以使用該屬性確認動作的目前配置。
    Studio 中的「追蹤輸出」視窗顯示了虛擬客服專員聊天指令碼範例開始的追蹤結果。
  5. 如果需要，請返回指令碼並進行變更。
  6. 要存取動作的線上說明，在畫布上將其選中，然後按鍵盤上的 F1。每個動作的線上說明介紹了有關在指令碼中使用該動作的屬性和其他資訊。
  7. 如果想重新開始，請點擊結束聊天，刷新瀏覽器視窗並重複此流程，從第 2 步開始。