Exemple d'intégration d'agents virtuels personnalisés

NICE CXone a mis au point un exemple de tunnel de proxy que vous pouvez utiliser. Vous pouvez configurer cet exemple d’intégration personnalisée afin de mieux comprendre le fonctionnement des intégrations personnalisées. Cet exemple simule une intégration d'agent virtuel personnalisée de type texte utilisant le chat ACD CXone.

Cet exemple de code diffère du tunnel de proxy utilisé dans une intégration réelle. Dans une intégration réelle, le tunnel de proxy est configuré pour communiquer avec les points de terminaison d’un agent virtuel. L’exemple de code ne communique pas avec un réel agent virtuel. À la place, il est configuré pour renvoyer en écho la saisie de l’utilisateur qui le teste. Ainsi, si vous saisissez Bonjour Chatbot dans la fenêtre de test, la réponse est Bonjour Chatbot.

Pour configurer l’exemple d’intégration, vous devez télécharger et installer l’exemple de code de proxy dans votre environnement. L’exemple de tunnel de proxy est disponible dans différents langages de programmation. Votre équipe peut choisir le langage avec lequel elle est le plus à l’aise.

Le modèle de document de conception technique (TDD) destiné à l’intégration d’agents virtuels personnalisée comprend des exemples basés sur cet exemple d’intégration. Les exemples donnés dans le modèle de TDD peuvent vous aider à mieux appréhender l’intégration personnalisée d’un agent virtuel.

Certains liens sur cette page renvoient vers des sites externes à l’aide en ligne de CXone.

Conditions

Pour tester l’exemple d’intégration, vous devez au préalable :

  • installer Studio sur votre ordinateur.
  • Fichier ZIP d'échantillon de code téléchargé. L’exemple de code est disponible dans les langages suivants :
    • C# .NET
    • Java
    • Node.js
    • PHP
    • Python
  • prévoir les dépendances IDE et compilateur pour le langage de l’exemple de code que vous utilisez :
    • C# .NET : VS Code ou autre éditeur de code.
    • Java : VS Code Community, Jet Brains, Net Beans, Intelli J, Eclipse, ou autre. Si vous utilisez l’éditeur VS Code, vous devez télécharger et installer le pack d’extension Java sur le site Visual Studio Marketplace.
    • Node.js : NPM.
    • PHP : VS Code ou autre éditeur de code.
    • Python : VS Code ou autre éditeur de code.
  • installer Ngrok sur votre ordinateur. Vous trouverez le programme d’installation sur ce site : https://ngrok.com/download.

Effectuez chacune de ces tâches dans l'ordre indiqué.

Configuration du point de terminaison de tunnel proxy

Exécutez cet appel d’API sur un port localhost. Copiez le numéro du port sur lequel s’exécute le service. Vous aurez besoin de ce numéro dans une étape ultérieure. Cliquez sur le menu déroulant pour afficher les instructions de configuration du point de terminaison dans chaque langage disponible.

  1. Extrayez le contenu du fichier ProxyTunnelExamples.zip.

  2. Dans l’éditeur de code, accédez au dossier contenant le code du tunnel de proxy C# parmi les fichiers extraits.

    cd ProxyTunnel/examples/c#/ProxyTunnel

  3. Ouvrez le fichier Program.cs. Ce fichier contient le code.

  4. Ouvrez PowerShell et exécutez la commande suivante :

    dotnet run

  5. Mémorisez le numéro du port sur lequel s’exécute le service. Dans l’exemple illustré ci-dessous, il s’agit du port 8080.

Vous pouvez configurer le point de terminaison du tunnel de proxy à l’aide d’un éditeur de code. Si vous n’avez pas d’éditeur de code Java, vous pouvez utiliser un utilitaire comme Apache Maven, qui vous permet d’exécuter des fichiers Java. Les deux méthodes sont décrites ici.

Utilisation d’un éditeur de code

Si vous utilisez l’éditeur VS Code, vous devez télécharger et installer le pack d’extension Java sur le site Visual Studio Marketplace. Ce pack d’extension place une option Run | Debug au-dessus de la fonction principale.

  1. Extrayez le contenu du fichier ProxyTunnelExamples.zip.
  2. Dans l’éditeur de code, ouvrez le dossier contenant le code du tunnel de proxy Java. Le chemin d’accès au code du tunnel de proxy Java est :

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

  3. Exécutez le point de terminaison à l’aide du bouton Run qui s’affiche au-dessus de la fonction principale. En voici une illustration :

    Le code de tunnel de proxy Java dans l’éditeur VS Code montant l’option Run | Debug au-dessus de la fonction principale public static voice main (String[] args).

  4. L’application est initialisée. Notez le port indiqué en haut de la sortie dans la fenêtre du terminal. Dans l’image ci-dessous, le port est 8080.

    Sortie du terminal pour Java montrant le port sur lequel s’exécute le tunnel de proxy, 8080 (http).

Utilisation des utilitaires Java

  1. Installez les utilitaires suivants :
  2. Configurez les variables d’enregistrement nécessaires pour exécuter le programme Java en local :
    1. Sur votre ordinateur, recherchez Paramètres système avancés ou Variables d’environnement.
    2. Sous l’onglet Avancé de la fenêtre Propriétés système, cliquez sur Variables d’environnement.
    3. Dans la section Variables système, sélectionnez Path, puis cliquez sur Modifier.

    4. Créez deux nouveaux chemins pour les dossiers Bin Maven et Java en accédant à l’emplacement d’installation de chaque utilitaire. Voici deux exemples de chemin :

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

      C:\Programmes\Java\jdk-18.0.2\bin

  3. Extrayez le contenu du fichier ProxyTunnelExamples.zip.

  4. Initialisez l’application :

    1. Ouvrez PowerShell ou l’invite de commande et changez de répertoire pour accéder au dossier contenant l’application. Par exemple:

      cd ProxyTunnel\examples\Java

    2. Exécutez les commandes suivantes afin de compiler l’application et de la convertir en pack Maven :

      mvn compile
      mvn package

      Cela génère un fichier JAR dans un répertoire nommé \target.

    3. Exécutez le fichier JAR généré.

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

    4. Notez le numéro de port indiqué dans la sortie d’initialisation dans la fenêtre d’invite de commande. Dans l’exemple ci-dessous, le port est 8080.

      Exemple de résultats obtenus en exécutant le fichier JAR généré. Il montre le numéro de port à utiliser.

Veillez à ce que le nœud et NPM soient installés sur votre ordinateur avant d’accomplir cette tâche.

  1. Extrayez le contenu du fichier ProxyTunnelExamples.zip.

  2. Ouvrez l’invite de commande ou PowerShell et changez de répertoire pour accéder à l’emplacement des fichiers Node.js.

    cd ProxyTunnel/examples/Nodejs

  3. Exécutez cette commande dans le dossier de code Nodejs :

    npm install

  4. Exécutez le point de terminaison. Utilisez la commande adaptée au système d’exploitation utilisé.

    Linux :

    export DEBUG='javascriptechoproxy:server'
    npm run start

    Windows avec PowerShell : 

    npm run devstart

  5. Notez le numéro de port indiqué dans la sortie d’initialisation dans la fenêtre d’invite de commande. Par exemple, ce peut être 8080.

PHP doit être installé sur votre ordinateur pour utiliser cette option. Si vous n’avez pas encore installé PHP, vous avez deux possibilités :

  • Utilisez Chocolatey, un outil de gestion logicielle. C’est la solution recommandée.  Pour installer PHP avec Chocolatey, ouvrez PowerShell en tant qu’administrateur et saisissez cette commande :

    choco install php

  • Installez PHP directement à partir du site web Windows PHP.

Après avoir installé PHP, suivez ces étapes pour configurer le point de terminaison du tunnel de proxy :

  1. Extrayez le contenu du fichier ProxyTunnelExamples.zip.

  2. Utilisez l’invite de commande ou PowerShell pour accéder au dossier \PHP.

    cd ProxyTunnel/examples/php

  3. Exécutez cette commande à partir du dossier PHP :

    php -S localhost:8000

    L’application est initialisée et s’exécute sur le port 8000. Mémorisez ce numéro de port afin de l’utiliser ultérieurement dans le processus de configuration.

  1. Extrayez le contenu du fichier ProxyTunnelExamples.zip.

  2. Dans votre éditeur de code, ouvrez le dossier Python de tunnel de proxy.
  3. À l’aide de la console de l’éditeur de code, modifiez le dossier contenant le fichier API.

  4. Dans le volet du terminal de l’éditeur de code ou l’invite de commande, installez Flask sur votre système à l’aide de la commande suivante :

    pip install flask

  5. Utilisez cette commande pour exécuter le tunnel de proxy :

    python echo-proxy-tunnel.py

    Notez le numéro de port indiqué dans la sortie d’initialisation dans la fenêtre du terminal. Mémorisez ce numéro de port afin de l’utiliser ultérieurement dans le processus de configuration. Dans l’exemple illustré ci-dessous, le port est 5000.

    Exemple de la sortie obtenue en exécutant le tunnel de proxy dans Python. Le numéro de port dans cet exemple est 5000.

Exposition du point de terminaison de tunnel de proxy

Il est nécessaire d’exposer le point de terminaison du tunnel de proxy afin que CXone puisse y accéder de manière globale. Pour ce faire, utilisez Ngrok.

  1. Si ce n’est déjà fait, installez Ngrok.

  2. Lancez Ngrok à l’aide de cette commande dans l’invite de commande :

    ngrok http [port number]

    où [port number] correspond au numéro de port que vous avez noté lors de la configuration du point de terminaison.

  3. Copiez l’URL de serveur que Ngrok expose ainsi que les points de terminaison d’API nécessaires.

    Exemple des résultats obtenus en exécutant Ngrok sur le point de terminaison du tunnel de proxy, qui montrent les URL ainsi exposées.

    Dans l’exemple illustré ci-dessous, l’URL exposée est https://4db3-5-46-62-207.nrgok.io. Il s’agit de l’URL de base pour le webhook. Déterminez le point de terminaison à utiliser avec votre URL. Enregistrez l’URL pour l’utiliser lors de la configuration de l’action Studio Textbot dans une tâche ultérieure.

    Langue Détails du terminal
    C#

    Le serveur accepte les demandes Virtual Agent Hub à la méthode POST proxy/performbotexchange. L’URL de webhook est :

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

    Le serveur accepte les demandes Virtual Agent Hub à la méthode POST api/proxy. L’URL de webhook est :

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

    Le serveur accepte les demandes Virtual Agent Hub à la méthode POST api/relay. L’URL de webhook est :

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

    Le serveur accepte les demandes Virtual Agent Hub à la méthode POST relayExchangeResponse. L’URL de webhook est :

    https://[URL de base]/relayExchangeResponse
    PHP

    Le serveur accepte les demandes Virtual Agent Hub à la méthode POST proxy.php. L’URL de webhook est :

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

Les étapes décrites dans cette section en vue de déterminer le point de terminaison s’appliquent uniquement à l’exemple d’intégration. Lorsque vous créez votre propre point de terminaison, les informations reflètent les besoins de votre organisation.

Configuration d’un script de chat simple dans Studio

  1. Téléchargez ce script de chat simple.
  2. Extrayez le fichier TextBotExchangeExample.xml sur votre ordinateur.
  3. Dans Studio, cliquez sur Fichier > Importer depuis un fichier, sélectionnez le fichier extrait, puis cliquez sur Ouvrir.
  4. Enregistrez le script. Mémorisez le nom donné au script. Laissez le script ouvert. Vous y reviendrez ultérieurement.

Création d’une compétence de chat et d’un point de contact dans CXone

Vous devez créer une compétenceFermé Utilisé pour automatiser la livraison des interactions en fonction des compétences, des capacités et des connaissances des agents de chat et un point de contactFermé Le point d'entrée qu'un contact entrant utilise pour initier une interaction, tel qu'un numéro de téléphone ou une adresse e-mail.. Le point de contact appelle le script que vous avez importé. C’est ainsi que CXone achemine les contacts vers votre agent virtuel.

  1. Dans CXone, cliquez sur le sélecteur d'application et sélectionnezACD.
  2. Cliquez sur Paramètres des contacts > Compétences ACD, puis créez une compétence de chat. Vous devez attribuer un Nom à la compétence et l’attribuer à une Campagne. Il est recommandé de créer une campagne à utiliser pour l’exemple d’intégration. Vous pouvez accepter les valeurs par défaut pour toutes les autres options de compétence.

  3. Accédez à Paramètres des contacts > Points de contact et créez un point de contact avec les paramètres suivants :

    • Type de média : sélectionnez Chat.
    • Script : sélectionnez le nom du script que vous avez importé pour l’exemple d’intégration.
    • Compétence : sélectionnez le nom de la compétence que vous avez créée dans cette tâche.

  4. Après avoir créé le point de contact, copiez l’URL du Point de contact affichée sous l’onglet Détails. Collez-la dans un onglet de votre navigateur. Vous utiliserez cette URL par la suite afin de tester le script.

    Onglet Détails du point de contact créé pour tester l’exemple de tunnel de proxy. Le champ Point de contact affiche l’URL qui invoque le script.

Configuration de l’action Textbot Exchange

Cette étape configure CXone de manière à communiquer avec le point de terminaison du tunnel de proxy.

  1. Dans Studio, ouvrez l’exemple de script que vous avez importé, s’il n’est pas déjà ouvert.

  2. Double-cliquez sur l’une des actions Textbot Exchange pour ouvrir Virtual Agent Hub.

    L'icône de l'action Textbot Exchange. Il s’agit d’une bulle de chat avec des yeux de robot à l’intérieur, une antenne sur le dessus et les caractères ABC en dessous.
  3. Cliquez sur Ajouter un robot.
  4. Saisissez un Nom d’agent virtuel (Bot), puis sélectionnez Custom Exchange Endpoint comme Fournisseur de bot.
  5. Cliquez sur Suivant.
  6. Saisissez l’URL de webhook. Il s’agit de l’URL que vous avez enregistrée après avoir exposé le point de terminaison du tunnel de proxy.
  7. Cliquez sur Suivant.
  8. Sur la page Voix, sélectionnez Texte seulement sous Options d’intégration vocale, puis cliquez sur Suivant.
  9. Sur la page Tester + Ajouter, cliquez sur Commencer par l’intention de bienvenue. Testez d’autres options, comme l’envoi d’une charge utile, si vous le souhaitez. Si aucune erreur ne survient, passez à l’étape suivante. Si votre test aboutit à des erreurs, examinez les tâches précédentes afin de vérifier la configuration et l’exposition du point de terminaison du tunnel de proxy, ainsi que la configuration dans Virtual Agent Hub.

Test du script à partir d’une fenêtre de chat

Dès lors que vous avez résolu les éventuelles erreurs survenues lors du test de la configuration de l’action Textbot Exchange, vous pouvez tester le script par le biais de l’URL de point de contactFermé Le point d'entrée qu'un contact entrant utilise pour initier une interaction, tel qu'un numéro de téléphone ou une adresse e-mail. que vous avez copiée lors d’une tâche antérieure.

  1. Dans Studio, ouvrez l’exemple de script que vous avez importé.
  2. Cliquez sur Débogage > Capturer le script > Instance suivante uniquement.
  3. Dans l’onglet de navigateur où vous avez collé l’URL du point de contact, saisissez un message dans le champ Saisissez votre texte, puis cliquez sur Envoyer.

  4. La fenêtre Trace Output s'ouvre dans Studio. Elle affiche la progression du script à mesure que vous envoyez des messages et que le script y répond.

    Cliquez sur une action dans le volet principal de la fenêtre Trace Output .

    • L'onglet Variables présente toutes les variables du script une fois l'action sélectionnée terminée. Il donne également la valeur de chaque variable à ce stade du script.
    • L'onglet Propriétés affiche les propriétés de l'action sélectionnée. Vous pouvez l'utiliser pour vérifier la configuration actuelle de l'action.
    Fenêtre Trace Ouput de Studio montrant le résultat de trace à partir du début du script d’agent virtuel de chat fourni en exemple
  5. Revenez au script et apportez des modifications si nécessaire.
  6. Pour accéder à l’aide en ligne concernant une action, sélectionnez l’action sur le canevas et appuyez sur la touche F1 du clavier. La page d'aide en ligne de chaque action décrit les propriétés et autres informations se rapportant à l'utilisation de l'action dans un script.
  7. Si vous voulez reprendre le test depuis le début, cliquez sur Quitter la conversation, actualisez la fenêtre du navigateur et recommencez la procédure à partir de l’étape 2.