Exemple d’intégration d’agent virtuel personnalisée

NICE CXone a mis au point un exemple de tunnel mandataire que vous pouvez utiliser. Vous pouvez mettre en place cet exemple d’intégration personnalisée pour mieux comprendre le fonctionnement des intégrations personnalisées. Cet exemple simule l’intégration personnalisée d’un agent virtuel textuel à l’aide du clavardage ACD CXone.

Le code de cet exemple est différent du tunnel mandataire utilisé dans une intégration réelle. Dans une intégration réelle, le tunnel mandataire est configuré pour communiquer avec les terminaux d’un agent virtuel. L’exemple de code ne communique pas avec un agent virtuel réel. Au lieu de cela, il est configuré pour renvoyer la saisie de l’utilisateur qui le teste. Ainsi, si vous tapez 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 mandataire dans votre environnement. L’exemple de tunnel mandataire est disponible dans plusieurs langages de programmation. Votre équipe peut utiliser la langue avec laquelle elle se sent le plus à l’aise.

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

Certains liens de cette page ouvrent des sites en dehors de l’aide en ligne de CXone.

Exigences

Pour tester l’exemple d’intégration, les conditions suivantes doivent être remplies :

  • Studio installé sur votre ordinateur.
  • Téléchargez le fichier ZIP de l’exemple de code. Des exemples de code sont disponibles dans les langages suivants :
    • C# .NET
    • Java
    • Node.js
    • PHP
    • Python
  • Dépendances d’IDE et du 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 à partir du site Web Visual Studio Marketplace.
    • Node.js : NPM.
    • PHP : VS Code ou autre éditeur de code.
    • Python : VS Code ou autre éditeur de code.
  • Ngrok installé sur votre ordinateur. Vous pouvez trouver l’installation sur ce site : https://ngrok.com/download.

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

Configuration du terminal du tunnel mandataire

Exécutez cet appel API sur un port local. Notez le numéro de port sur lequel le service est exécuté. Vous aurez besoin de ce numéro dans une étape ultérieure. Cliquez sur la liste déroulante pour afficher les instructions de configuration du terminal pour chaque langue disponible.

  1. Extrayez le contenu du fichier ProxyTunnelExamples.zip.

  2. Dans votre éditeur de code, accédez au dossier contenant le code du tunnel mandataire C# dans 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. Rappelez-vous le numéro de port sur lequel le service est exécuté. Dans l’image d’exemple suivante, il fonctionne sur le port 8080.

Vous pouvez configurer le terminal du tunnel mandataire à l’aide d’un éditeur de code. Si vous ne disposez pas d’un éditeur de code Java, vous pouvez utiliser un utilitaire tel qu’Apache Maven, qui vous permet d’exécuter des fichiers Java. Les deux méthodes sont décrites ici.

Utiliser un éditeur de code

Si vous utilisez l’éditeur VS Code, vous devez télécharger et installer le pack d’extension Java à partir du site Web Visual Studio Marketplace. Ce pack d’extension place une option Exécuter | Déboguer au-dessus de la fonction principale.

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

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

  3. Exécutez le terminal à l’aide du bouton Exécuter qui apparaît en haut de la fonction principale. Il se présente comme suit :

    Le code du tunnel mandataire Java dans l’éditeur de code VS montre l’option Exécuter | Déboguer au-dessus de la fonction principale : public static voice main (String[] args).

  4. L’application est initialisée. Prenez note du port en haut de la sortie dans le terminal. Dans l’image suivante, le port est 8080.

    La sortie de terminal pour Java montre le port sur lequel le tunnel mandataire fonctionne, 8080 (http).

Utiliser les utilitaires Java

  1. Installez les utilitaires suivants :
  2. Définissez les variables d’environnement nécessaires à l’exécution locale du programme Java :
    1. Sur votre ordinateur, recherchez Paramètres système avancés ou Variables d’environnement.
    2. Dans l’onglet Avancé de la fenêtre Propriétés du système, cliquez sur Variables d’environnement.
    3. Dans la section Variables du système, sélectionnez Chemin et cliquez sur Modifier.

    4. Créez deux nouveaux chemins pour les dossiers Bin Maven et Java en naviguant jusqu’à l’emplacement où chaque utilitaire est installé. Par exemple, les chemins peuvent être les suivants :

      C:\NProgram Files\Napache-maven-3,8,6-bin\Napache-maven-3.8.6\Nbin

      C:\NProgram Files\NJava\NJdk-18.0.2\Nbin

  3. Extrayez le contenu du fichier ProxyTunnelExamples.zip.

  4. Initialisez l’application : 

    1. Ouvrez Powershell ou l’invite de commande et changez le répertoire en dossier contenant l’application. Par exemple :

      cd ProxyTunnel\examples\Java

    2. Exécutez les commandes suivantes pour compiler l’application et la convertir en un paquet Maven :

      mvn compile
      mvn package

      Cette action 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. Prenez note du numéro de port à partir de la sortie d’initialisation dans la fenêtre d’invite de commande. Dans l’exemple suivant, le port est 8080.

      Exemple des résultats de l’exécution du fichier JAR généré. Indique le numéro de port à utiliser.

Assurez-vous que le nœud et NPM sont installés sur votre ordinateur avant d’effectuer cette tâche.

  1. Extrayez le contenu du fichier ProxyTunnelExamples.zip.

  2. Ouvrez l’invite de commande ou le PowerShell et accédez à l’emplacement des fichiers Node.js.

    cd ProxyTunnel/examples/Nodejs

  3. Exécutez cette commande depuis le dossier du code Nodejs :

    npm install

  4. Exécutez le terminal. Utilisez la commande correspondant au système d’exploitation que vous utilisez.

    Linux :

    export DEBUG='javascriptechoproxy:server'
    npm run start

    Windows à l’aide de Powershell : 

    npm run devstart

  5. Prenez note du numéro de port à partir de la sortie d’initialisation dans la fenêtre d’invite de commande. Par exemple, il peut s’agir de 8080.

Vous devez avoir installé PHP sur votre ordinateur pour utiliser cette option. Si PHP n’est pas déjà installé, il existe deux options pour l’installer :

  • Utilisez Chocolatey, un outil de gestion de logiciels. Il s’agit de l’option privilégié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 les étapes suivantes pour configurer le terminal du tunnel mandataire :

  1. Extrayez le contenu du fichier ProxyTunnel_PHP.zip.

  2. Utilisez l’invite de commande ou le 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 fonctionne sur le port 8000. Mémorisez ce numéro de port pour l’utiliser ultérieurement au cours de la procédure d’installation.

  1. Extrayez le contenu du fichier ProxyTunnelExamples.zip.

  2. Dans votre éditeur de code, ouvrez le dossier du tunnel mandataire Python.
  3. Utilisez la console de l’éditeur de code pour accéder au dossier contenant le fichier API.

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

    pip install flask

  5. Cette commande permet d’exécuter le tunnel mandataire :

    python echo-proxy-tunnel.py

    Prenez note du numéro de port à partir de la sortie d’initialisation dans la fenêtre du terminal. Mémorisez ce numéro de port pour l’utiliser ultérieurement au cours de la procédure d’installation. Dans l’exemple suivant, le port est 5000.

    Exemple de résultat de l’exécution du tunnel mandataire dans Python. Dans cet exemple, le numéro de port est 5000.

Exposer le terminal du tunnel mandataire

Le terminal du tunnel mandataire doit être exposé de manière à ce que CXone puisse y accéder globalement. Utilisez Ngrok pour exposer le terminal.

  1. Installez Ngrok, si vous ne l’avez pas encore fait.

  2. Démarrez Ngrok en utilisant cette commande à partir de l’invite de commande :

    ngrok http [port number]

    où [numéro de port] est le numéro de port que vous avez noté lors de la configuration du terminal.

  3. Copiez l’URL du serveur que Ngrok expose et les terminaux API requis.

    Un exemple des résultats de l’exécution de Ngrok sur le terminal du tunnel mandataire, montrant les URL qui sont exposées en conséquence.

    Dans l’image d’exemple, l’URL exposée est https://4db3-5-46-62-207.nrgok.io. Il s’agit de l’URL de base du webhook. Déterminez le terminal à utiliser avec votre URL. Enregistrez l’URL pour l’utiliser lorsque vous configurerez 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 votre webhook est la suivante :

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

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

    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 votre webhook est la suivante :

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

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

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

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

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

Les étapes de détermination du terminal décrites dans cette section ne s’appliquent qu’à l’exemple d’intégration. Lorsque vous créez votre propre terminal, il peut s’agir de n’importe quel élément répondant aux besoins de votre organisation.

Configuration d’un script de clavardage simple dans Studio

  1. Téléchargez ce script de clavardage simple.
  2. Extrayez le fichier TextBotExchangeExample.xml sur votre ordinateur.
  3. Dans Studio, cliquez sur Fichier > Importer à partir d’un fichier, sélectionnez le fichier extrait et cliquez sur Ouvrir.
  4. Enregistrez le script. N’oubliez pas le nom que vous donnez au script. Laissez le script ouvert. Vous y reviendrez dans une tâche ultérieure.

Créer une compétence de clavardage et un point d’accès 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 clavardage et un point d’accèsFermé Le point d’entrée qu’un contact entrant utilise pour lancer une interaction, tel qu’un numéro de téléphone ou une adresse courriel.. Le point d’accès 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électionnez ACD.
  2. Cliquez sur Paramètres du contact > Compétences ACD et créez une compétence de clavardage. Vous devez donner à la compétence un nom et l’affecter à une campagne. Vous pouvez souhaiter 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étences.

  3. Accédez à Paramètres du contact > Points d’accès et créez un point d’accès avec les paramètres suivants :

    • Type de support : Sélectionnez Clavardage.
    • Script : Sélectionnez le nom du script que vous avez importé pour l’utiliser avec 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 d’accès, copiez l’URL du point d’accès affichée dans l’onglet Détails. Collez-la dans un onglet de votre navigateur. Vous utiliserez cette URL dans une tâche ultérieure pour tester le script.

    L’onglet Détails du point d’accès créé pour tester l’exemple de tunnel mandataire. Le champ Point d’accès affiche l’URL qui invoque le script.

Configurer l’action d’échange Textbot

Cette étape permet de configurer CXone pour communiquer avec le terminal du tunnel mandataire de l’échantillon.

  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 dialogue avec des yeux de robot à l’intérieur et une antenne au sommet avec les caractères ABC en dessous.
  3. Cliquez sur Ajouter un robot logiciel.
  4. Saisissez un nom d’agent virtuel (bot), puis sélectionnez Terminal d’échange personnalisé comme Fournisseur de bot.
  5. Cliquez sur Suivant.
  6. Saisissez l’URL de votre Webhook. Il s’agit de l’URL que vous avez sauvegardée après avoir exposé le terminal du tunnel mandataire.
  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 Démarrer avec l’intention de bienvenue. Testez d’autres options, telles que l’envoi d’une charge utile personnalisée, si nécessaire. S’il n’y a pas d’erreur, passez à la tâche suivante. Si votre test aboutit à des erreurs, revoyez les tâches précédentes pour vérifier la et l’exposition configuration et l’exposition du terminal du tunnel mandataire et la configuration dans Virtual Agent Hub.

Tester le script à partir d’une fenêtre de clavardage

Lorsque vous avez résolu les erreurs qui se sont produites lors du test de la configuration de l’action Textbot Exchange, vous pouvez tester le script en utilisant l’URL du point d’accèsFermé Le point d’entrée qu’un contact entrant utilise pour lancer une interaction, tel qu’un numéro de téléphone ou une adresse courriel. que vous avez copié dans une tâche précédente.

  1. Dans Studio, ouvrez l’exemple de script que vous avez importé.
  2. Cliquez sur Déboguer > Script de capture > Instance suivante uniquement.
  3. Dans l’onglet du navigateur où vous avez collé l’URL du point d’accès, tapez un message dans le champ Entrez votre texte et cliquez sur Envoyer.

  4. Dans Studio, la fenêtre Tracer la sortie s’ouvre. Elle affiche la progression du script au fur et à mesure que vous envoyez des messages et que le script répond.

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

    • L’onglet Variables affiche toutes les variables qui existent dans le script lorsque l’action sélectionnée est terminée. Il indique également la valeur de chaque variable à ce stade du script.
    • L’onglet Propriétés présente les propriétés de l’action sélectionnée. Vous pouvez l’utiliser pour vérifier la configuration actuelle de l’action.
    La fenêtre Tracer la sortie de Studio, qui affiche les résultats de la trace depuis le début de l’exemple de script d’agent virtuel de clavardage.
  5. Revenez au script et apportez des modifications, si nécessaire.
  6. Pour accéder à l’aide en ligne d’une action, sélectionnez-la dans le canevas et appuyez sur F1 sur votre clavier. La page d’aide en ligne de chaque action décrit les propriétés et d’autres informations relatives à l’utilisation de l’action dans un script.
  7. Si vous voulez recommencer, cliquez sur Mettre fin au clavardage, actualisez la fenêtre du navigateur et recommencez ce processus en commençant par l’étape 2.