Ejemplo de integración personalizada de agente virtual

NICE CXone desarrolló un túnel de proxy de muestra para que usted use. Puede configurar esta integración personalizada de ejemplo para comprender mejor cómo funcionan las integraciones personalizadas. Este ejemplo simula una integración personalizada de agente virtual de texto usando el chat ACD de CXone.

El código de muestra de este ejemplo es diferente del túnel proxy usado en una integración real. En una integración real, el túnel de proxy se configura para comunicarse con los terminales de un agente virtual. El código de muestra no se comunica con un agente virtual real. En cambio, está configurado para devolver la entrada que llega del usuario que lo está probando. Por eso, si escribe Hola, chatbot en la ventana de prueba, la respuesta es Hola, chatbot.

Para configurar la integración de ejemplo, debe descargar e instalar el código proxy de muestra en su entorno. El túnel de proxy de muestra está disponible en varios lenguajes de programación distintos. Su equipo puede usar el lenguaje que le resulte más cómodo para trabajar.

La plantilla de la integración personalizada de agente virtual llamada documentación de diseño técnico (TDD) contiene ejemplos basados en esta integración de ejemplo. Los ejemplos de la plantilla TDD pueden ayudarlo a comprender mejor la integración personalizada de agente virtual.

Algunos enlaces de esta página abren sitios fuera de la ayuda en línea de CXone.

Requisitos

Para probar la integración de ejemplo, debe tener:

  • Studio instalado en su computadora.
  • Descargue el archivo ZIP del código de muestra. El código de muestra está disponible en los siguientes lenguajes:
    • C# .NET
    • Java
    • Node.js
    • PHP
    • Python
  • IDE y dependencias del compilador para el lenguaje del código de muestra que está usando:
    • C# .NET: VS Code u otro editor de código.
    • Java: VS Code Community, Jet Brains, Net Beans, Intelli J, Eclipse u otros. Si usa el editor VS Code, deberá descargar e instalar el Paquete de Extensión de Java desde el sitio web de Visual Studio Marketplace.
    • Node.js: NPM.
    • PHP: VS Code u otro editor de código.
    • Python: VS Code u otro editor de código.
  • Ngrok instalado en su computadora. Puede buscar la instalación en este sitio: https://ngrok.com/download.

Complete cada una de estas tareas en el orden dado.

Configure el terminal del túnel de proxy

Ejecute esta llamada API en un puerto localhost. Copie el número de puerto en el que se ejecuta el servicio. Necesitará el número en un paso posterior. Haga clic en el menú desplegable para ver las instrucciones de cómo configurar el terminal para cada lenguaje disponible.

  1. Extraiga el contenido del archivo ProxyTunnelExamples.zip.

  2. En su editor de código, desplácese a la carpeta que contiene el código del túnel de proxy C# en los archivos extraídos.

    cd ProxyTunnel/examples/c#/ProxyTunnel

  3. Abre el archivoProgram.cs. Este archivo contiene el código.

  4. Abra PowerShell y ejecute el siguiente comando:

    dotnet run

  5. Recuerde el número de puerto en el que se está ejecutando el servicio. En la imagen del ejemplo siguiente, se está ejecutando en el puerto 8080.

Puede configurar el terminal del túnel de proxy mediante un editor de código. Si no tiene un editor de código de Java, puede usar una utilidad como Apache Maven, que le permite ejecutar archivos de Java. Aquí se describen ambos métodos.

Use a editor de código

Si usa el editor VS Code, deberá descargar e instalar el Paquete de Extensión de Java desde el sitio web de Visual Studio Marketplace. Este paquete de extensión coloca una opción Ejecutar | Depurar encima de la función principal.

  1. Extraiga el contenido del archivo ProxyTunnelExamples.zip.
  2. En su editor de código, abra la carpeta que contiene el código del túnel de proxy Java. La ruta al código del túnel de proxy Java es:

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

  3. Ejecute el terminal usando el botón Ejecutar que aparece en la parte superior de la función principal. Se ve así:

    El código Java del túnel de proxy en el editor VS Code donde se observa la opción Ejecutar | Depurar encima de la función principal: public static voice main (String[] args).

  4. La aplicación se ha inicializado. Tome nota del número puerto, que se encuentra en la parte superior de la salida en el terminal. En la imagen siguiente, el puerto es 8080.

    La salida de terminal para Java donde se observa que el puerto del terminar se está ejecutando, 8080 (http).

Use utilidades Java

  1. Instale las siguientes utilidades:
  2. Configure las variables del entorno necesarias para ejecutar el programa Java a nivel local:
    1. En su computadora, busque Configuración avanzada del sistema o Variables de entorno.
    2. En la pestaña Opciones avanzadas de la ventana Propiedades del sistema, haga clic en Variables de entorno.
    3. En la sección Variables del sistema, seleccione Path y haga clic en Editar.

    4. Cree dos rutas nuevas para las carpetas Bin de Maven y Java buscando la ubicación donde está instalada cada utilidad. Por ejemplo, las rutas podrían ser:

      C:\Archivos de programa\apache-maven-3,8,6-bin\apache-maven-3.8.6\bin

      C:\Archivos de programa\Java\jdk-18.0.2\bin

  3. Extraiga el contenido del archivo ProxyTunnelExamples.zip.

  4. Inicialice la aplicación: 

    1. Abra PowerShell o Símbolo del sistema y cambie el directorio a la carpeta que contiene la aplicación. Por ejemplo:

      cd ProxyTunnel\examples\Java

    2. Ejecute los comandos siguientes para compilar la aplicación y convertirla en un paquete Maven:

      mvn compile
      mvn package

      Esto genera un archivo JAR en un directorio llamado \target.

    3. Ejecute el archivo JAR generado.

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

    4. Tome nota del número puerto de la salida de inicialización en la ventana de Símbolo del sistema. En el ejemplo siguiente, el puerto es 8080.

      Un ejemplo de los resultados de ejecutar el archivo JAR generado. Muestra el número de puerto que se debe usar.

Verifique que el nodo y NPM estén instalados en su computadora antes de completar esta tarea.

  1. Extraiga el contenido del archivo ProxyTunnelExamples.zip.

  2. Abra Símbolo del sistema o PowerShell y cambie la ubicación de los archivos Node.js.

    cd ProxyTunnel/examples/Nodejs

  3. Ejecute este comando desde la carpeta del código de Nodejs:

    npm install

  4. Ejecute este terminal. Use el comando correspondiente al sistema operativo que esté usando.

    Linux:

    export DEBUG='javascriptechoproxy:server'
    npm run start

    Windows con PowerShell: 

    npm run devstart

  5. Tome nota del número puerto de la salida de inicialización en la ventana de Símbolo del sistema. Por ejemplo, podría ser 8080.

Debe tener PHP instalado en su computadora para usar esta opción. Si todavía no tiene PHP, hay dos opciones para instalarlo:

  • Use Chocolatey, una herramienta de gestión de software. Esta es la opción preferible.  El enlace abre un sitio de terceros en una pestaña o ventana nueva.Para instalar PHP con Chocolatey, abra PowerShell como Admin e ingrese este comando:

    choco install php

  • Instale PHP directamente desde el sitio web PHP for Windows.

Después de instalar PHP, siga estos pasos para configurar el terminal del túnel de proxy:

  1. Extraiga el contenido del archivo ProxyTunnel_PHP.zip.

  2. Use Símbolo del sistema o PowerShell para cambiar a la carpeta \PHP.

    cd ProxyTunnel/examples/php

  3. Ejecute este comando desde la carpeta de PHP:

    php -S localhost:8000

    La aplicación se ha inicializado y se está ejecutando en el puerto 8000. Recuerde este número de puerto, porque lo usará más adelante en el proceso de configuración.

  1. Extraiga el contenido del archivo ProxyTunnelExamples.zip.

  2. En su editor de código, abra la carpeta del túnel de proxy de Python.
  3. Use la consola del editor de código para cambiar a la carpeta que contiene el archivo API.

  4. En el panel de terminales de su editor de código, o usando Símbolo del sistema, instale Flask en su sistema usando este comando:

    pip install flask

  5. Use este comando para ejecutar el túnel de proxy:

    python echo-proxy-tunnel.py

    Tome nota del número puerto de la salida de inicialización en la ventana del terminal. Recuerde este número de puerto, porque lo usará más adelante en el proceso de configuración. En el ejemplo siguiente, el puerto es 5000.

    Un ejemplo de la salida al ejecutar el túnel de proxy en Python. El número de puerto en este ejemplo es 5000.

Exponga el terminal del túnel de proxy

El terminal del túnel de proxy debe estar expuesto, para que CXone pueda acceder a nivel global. Use Ngrok para exponer el terminal.

  1. Instale Ngrok, si todavía no lo ha hecho.

  2. Inicie Ngrok usando el comando de Símbolo del sistema:

    ngrok http [port number]

    donde [port number] es el número de puerto que anotó al configurar el terminal.

  3. Copie la URL del servidor que Ngrok exponga y los terminales API requeridos.

    Un ejemplo de los resultados de ejecutar Ngrok en el terminal del túnel de proxy, donde se observan las URL que quedan expuestas como resultado.

    En la imagen del ejemplo, la URL expuesta es https://4db3-5-46-62-207.nrgok.io. Esta es la URL base para el webhook. Determine qué terminal usar con su URL. Guarde la URL para usarla cuando configure la acción de textbot Studio en una tarea posterior.

    Idioma Detalles del terminal
    C#

    El servidor acepta solicitudes Virtual Agent Hub en el método POST proxy/performbotexchange. Su URL de webhook es:

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

    El servidor acepta solicitudes Virtual Agent Hub en el método POST api/proxy. Su URL de webhook es:

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

    El servidor acepta solicitudes Virtual Agent Hub en el método POST api/relay. Su URL de webhook es:

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

    El servidor acepta solicitudes Virtual Agent Hub en el método POST relayExchangeResponse. Su URL de webhook es:

    https://[URL base]/relayExchangeResponse
    PHP

    El servidor acepta solicitudes Virtual Agent Hub en el método POST proxy.php. Su URL de webhook es:

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

Los pasos para determinar el terminal que se describen en esta sección solo son válidos para la integración de ejemplo. Cuando cree su propio terminal, puede ser cualquier cosa que satisfaga las necesidades de su organización.

Configure un script de chat simple en Studio

  1. Descargue este script de chat simple.
  2. Extraiga el archivo TextBotExchangeExample.xml a su computadora.
  3. En Studio, haga clic en File > Importar desde archivo, seleccione el archivo extraído y haga clic en Abrir.
  4. Guarde el script. Recuerde el nombre que asignó al script. Deje el script abierto. Más adelante volverá a trabajar con él.

Cree una habilidad de chat y un punto de contacto en CXone

Debe crear una habilidadCerrado Se utiliza para automatizar la entrega de interacciones basadas en las habilidades, capacidades y conocimientos de los agentes de chat y un punto de contactoCerrado El punto de entrada que utiliza un contacto entrante para iniciar una interacción, como un número de teléfono o una dirección de correo electrónico.. El punto de contacto llama al script que usted importó. Así es como CXone enruta los contactos hacia su agente virtual.

  1. En CXone, haga clic en el selector de aplicaciones y seleccioneACD.
  2. Haga clic en Configuración del contacto > Habilidades ACD y cree una habilidad de chat. Debe asignar un Nombre a la habilidad y asignarla a una Campaña. Quizás desee crear una campaña para usarla con la integración de muestra. Puede aceptar los valores predeterminados de todas las demás opciones de la habilidad.

  3. Vaya a Configuración del contacto > Puntos de contacto y cree un punto de contacto con los siguientes valores:

    • Tipo de medio: seleccione Chat.
    • Script: seleccione el nombre del script que importó para usarlo con la integración de ejemplo.
    • Habilidad: seleccione el nombre de la habilidad que creó en esta tarea.

  4. Después de crear el punto de contacto, copie la URL del Punto de contacto que aparece en la pestaña Detalles. Péguela en una pestaña de su navegador. Usará esta URL en una tarea posterior para probar el script.

    La pestañas Detalles del punto de contacto creada para probar el túnel de proxy de muestra. El campo Punto de contacto muestra la URL que invoca el script.

Configurar la acción Intercambio de TextBot

Este paso configura CXone para que se comunique con el terminal del túnel de proxy de muestra.

  1. En Studio, abra el script de muestra que importó, si todavía no está abierto.

  2. Haga doble clic en una de las acciones Textbot Exchange para abrir Virtual Agent Hub.

    El ícono para la acción Intercambio de Textbot. Es una burbuja de conversación con ojos de robot, una antena encima y los caracteres ABC debajo.
  3. Haga clic en Agregar bot.
  4. Ingrese un Nombre de agente virtual (bot) y, después, seleccione Terminal personalizado de intercambio como Proveedor de bots.
  5. Haga clic en Siguiente.
  6. Ingrese su URL de webhook. Esta es la URL que guardó después de exponer el terminal del túnel de proxy.
  7. Haga clic en Siguiente.
  8. En la página Voz, seleccione Solo texto en Opciones de integración de voz y, después, haga clic en Siguiente.
  9. En la página Probar + Agregar, haga clic en Comenzar con intención de bienvenida. Pruebe las otras opciones, por ejemplo enviar una carga útil personalizada, según prefiera. Si no hay errores, pase a la siguiente tarea. Si la prueba genera errores, revise las tareas anteriores para verificar la configuración y la exposición del terminal del túnel de proxy, así como la configuración en Virtual Agent Hub.

Probar el script desde una ventana de chat

Después de resolver los errores que hayan surgido al probar la configuración de la acción Textbot Exchange, puede probar el script usando la URL del punto de contactoCerrado El punto de entrada que utiliza un contacto entrante para iniciar una interacción, como un número de teléfono o una dirección de correo electrónico. que copió en la tarea anterior.

  1. En Studio, abra el script de muestra que importó.
  2. Haga clic en Depurar > Capturar script > Solo siguiente instancia.
  3. En la pestaña del navegador donde pegó la URL del punto de contacto, escriba un mensaje en el campo Introduzca su texto y haga clic en Enviar.

  4. En Studio, se abre la ventana Salida de seguimiento. Muestra el avance del script a medida que usted envía mensajes y el script los responde.

    Haga clic en una acción del panel principal en la ventana Trace Output .

    • La pestaña Variables muestra todas las variables que existen en el script cuando la acción seleccionada se ha completado. Muestra también el valor que tiene cada variable en ese punto del script.
    • La pestaña Propiedades muestra las propiedades de la acción seleccionada. Puede usarla para verificar la configuración actual de la acción.
    La ventana Salida de seguimiento en Studio, donde se observan los resultados del seguimiento desde el principio del script de muestra del agente virtual de chat.
  5. Regrese al script y aplique cambios, si fuera necesario.
  6. Para acceder a la ayuda en línea de una acción, selecciónela en el lienzo y pulse F1 en su teclado. La página de ayuda en línea de cada acción describe las propiedades y demás información sobre cómo usar la acción en un script.
  7. Si desea volver a comenzar, haga clic en Finalizar conversación, actualice la ventana del navegador y repita este proceso desde el paso 2.