Exemplo de integração de agente virtual personalizada

A NICE CXone desenvolveu um exemplo de túnel proxy para você usar. Você pode configurar este exemplo de integração personalizada para entender melhor como funcionam as integrações personalizadas. Este exemplo é uma integração de agente virtual personalizada usando o chat do ACD do CXone.

O código de amostra neste exemplo é diferente do túnel proxy usado em uma integração real. Em uma integração real, o túnel proxy é configurado para se comunicar com os terminais de um agente virtual. O código de amostra não se comunica com um agente virtual real. Em vez disso, ele é configurado para ecoar a entrada do usuário que o testa. Portanto, se você digitar Olá chatbot na janela de teste, a resposta será Olá chatbot.

Para configurar a integração de exemplo, você deve baixar e instalar o código proxy de amostra em seu ambiente. O exemplo de túnel proxy está disponível em várias linguagens de programação diferentes. Sua equipe pode usar a linguagem com a qual se sente mais confortável em trabalhar.

O modelo para o documento de design técnico (TDD) de integração de agente virtual personalizada inclui exemplos baseados nesta integração de exemplo. Os exemplos no modelo TDD podem ajudar você a entender melhor uma integração personalizada de agente virtual.

Alguns links nesta página abrem sites fora da ajuda online do CXone.

Requisitos

Para testar a integração de exemplo, você deve ter:

  • Studio instalado no seu computador.
  • Baixado o arquivo ZIP do código de amostra. O código de amostra está disponível nas seguintes linguagens:
    • C# .NET
    • Java
    • Node.js
    • PHP
    • Python
  • Dependências do ambiente de desenvolvimento integrado e do compilador para a linguagem do código de amostra que você está usando:
    • C# .NET: VS Code ou outro editor de código.
    • Java: VS Code Community, Jet Brains, Net Beans, Intelli J, Eclipse ou outros. Se você usa o editor VS Code, precisa baixar e instalar o pacote de extensões Java do site do Visual Studio Marketplace.
    • Node.js: NPM.
    • PHP: VS Code ou outro editor de código.
    • Python: VS Code ou outro editor de código.
  • Ngrok instalado no seu computador. Você pode encontrar a instalação neste site: https://ngrok.com/download.

Complete cada uma dessas tarefas na ordem indicada.

Configurar o terminal do túnel proxy

Execute esta chamada de API em uma porta localhost. Anote o número da porta em que o serviço é executado. Você precisará do número em uma etapa posterior. Clique na lista suspensa para ver as instruções para configurar o terminal para cada linguagem disponível.

  1. Extraia o conteúdo do arquivo ProxyTunnelExamples.zip.

  2. Em seu editor de código, navegue até a pasta que contém o código do túnel do proxy C# nos arquivos extraídos.

    cd ProxyTunnel/examples/c#/ProxyTunnel

  3. Abra o arquivo Program.cs. Este arquivo contém o código.

  4. Abra o Powershell e execute o seguinte comando:

    dotnet run

  5. Lembre-se do número da porta em que o serviço está sendo executado. Na imagem de exemplo a seguir, ele está em execução na porta 8080.

Você pode configurar o terminal do túnel proxy usando um editor de código. Se você não tiver um editor de código Java, use um utilitário como o Apache Maven, que permite executar arquivos Java. Ambos os métodos são descritos aqui.

Usar um editor de código

Se você usa o editor VS Code, precisa baixar e instalar o pacote de extensões Java do site do Visual Studio Marketplace. Este pacote de extensão coloca uma opção Run | Debug acima da função principal.

  1. Extraia o conteúdo do arquivo ProxyTunnelExamples.zip.
  2. No seu editor de código, abra a pasta que contém o código do túnel proxy Java. O caminho do código do túnel proxy Java é:

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

  3. Execute o terminal usando o botão Run que aparece acima da função principal. Fica assim:

    O código do túnel proxy Java no editor VS Code mostrando a opção Run | Debug acima da função principal: public static voice main (String[] args).

  4. O aplicativo é inicializado. Anote a porta que está na parte superior da saída no terminal. Na imagem a seguir, a porta é 8080.

    A saída do terminal para Java mostrando a porta na qual o túnel proxy está em execução, 8080 (http).

Usar utilitários Java

  1. Instale os seguintes utilitários: 
  2. Configure as variáveis de ambiente necessárias para executar o programa Java localmente:
    1. No computador, procure por Configurações Avançadas do Sistema ou Variáveis de Ambiente.
    2. Na guia Avançado da janela Propriedades do Sistema, clique em Variáveis de Ambiente.
    3. Na seção Variáveis de sistema, selecione Caminho e clique em Editar.

    4. Crie dois novos caminhos para as pastas bin do Maven e do Java navegando até o local onde cada utilitário está instalado. Por exemplo, os caminhos podem ser:

      C:\Arquivos de Programas\apache-maven-3,8,6-bin\apache-maven-3.8.6\bin

      C:\Arquivos de Programas\Java\jdk-18.0.2\bin

  3. Extraia o conteúdo do arquivo ProxyTunnelExamples.zip.

  4. Inicialize o aplicativo: 

    1. Abra o Powershell ou o Prompt de Comando e altere o diretório para a pasta que contém o aplicativo. Por exemplo:

      cd ProxyTunnel\examples\Java

    2. Execute os seguintes comandos para compilar o aplicativo e convertê-lo em um pacote Maven:

      mvn compile
      mvn package

      Isso gera um arquivo JAR em um diretório chamado \target.

    3. Execute o arquivo JAR gerado.

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

    4. Anote o número da porta da saída de inicialização na janela do prompt de comando. No exemplo a seguir, a porta é 8080.

      Um exemplo dos resultados da execução do arquivo JAR gerado. Mostra o número da porta a ser usada.

Certifique-se de que o nó e o NPM estejam instalados em seu computador antes de concluir esta tarefa.

  1. Extraia o conteúdo do arquivo ProxyTunnelExamples.zip.

  2. Abra o Prompt de Comando e altere o diretório para o local dos arquivos do Node.js.

    cd ProxyTunnel/examples/Nodejs

  3. Execute este comando na pasta de código Nodejs:

    npm install

  4. Execute o terminal. Use o comando para o sistema operacional que você está usando.

    Linux:

    export DEBUG='javascriptechoproxy:server'
    npm run start

    Windows usando o powershell: 

    npm run devstart

  5. Anote o número da porta da saída de inicialização na janela do prompt de comando. Por exemplo, pode ser 8080.

Você precisa ter o PHP instalado no seu computador para usar esta opção. Se você ainda não tem o PHP instalado, há duas opções para instalá-lo:

  • Use o Chocolatey, uma ferramenta de gerenciamento de software. Essa é a opção preferencial.  Para instalar o PHP com Chocolatey, abra o Powershell como administrador e digite este comando:

    choco install php

  • Instale o PHP diretamente do site do Windows PHP.

Depois de instalar o PHP, siga estas etapas para configurar o expoint do túnel proxy:

  1. Extraia o conteúdo do arquivo ProxyTunnel_PHP.zip.

  2. Use o Prompt de Comando ou o PowerShell para mudar para a pasta \PHP.

    cd ProxyTunnel/examples/php

  3. Execute este comando na pasta PHP:

    php -S localhost:8000

    O aplicativo foi inicializado e está em execução na porta 8000. Lembre-se deste número de porta para usar depois no processo de configuração.

  1. Extraia o conteúdo do arquivo ProxyTunnelExamples.zip.

  2. Em seu editor de código, abra a pasta Python do túnel proxy.
  3. Use o console do editor de código para mudar para a pasta que contém o arquivo da API.

  4. No painel de terminal do seu editor de código ou usando o prompt de comando, instale o Flask em seu sistema usando este comando:

    pip install flask

  5. Use este comando para executar o túnel proxy:

    python echo-proxy-tunnel.py

    Anote o número da porta da saída de inicialização na janela do terminal. Lembre-se deste número de porta para usar depois no processo de configuração. Na imagem de exemplo a seguir, a porta é 5000.

    Um exemplo do resultado da execução do túnel proxy em Python. O número da porta neste exemplo é 5000.

Expor o terminal do túnel proxy

O terminal do túnel proxy deve ser exposto para que o CXone possa acessá-lo globalmente. Use o Ngrok para expor o terminal.

  1. Instale o Ngrok, se ainda não fez isso.

  2. Inicie o Ngrok usando este comando no prompt de comando:

    ngrok http [port number]

    onde [port number] é o número da porta que você anotou ao configurar o terminal.

  3. Copie o URL do servidor que o Ngrok expõe e os terminais de API necessários.

    Um exemplo dos resultados da execução do Ngrok no terminal do túnel proxy, mostrando os URLs expostos como resultado.

    Na imagem de exemplo, o URL exposto é https://4db3-5-46-62-207.nrgok.io. Esse é o URL base do webhook. Determine qual terminal usar com seu URL. Salve o URL para usar quando você configurar a ação textbot Studio em uma tarefa posterior.

    Idioma Detalhes do terminal
    C#

    O servidor aceita solicitações do Hub de Agente Virtual no método POST proxy/performbotexchange. O URL do seu webhook é:

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

    O servidor aceita solicitações do Hub de Agente Virtual no método POST api/proxy. O URL do seu webhook é:

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

    O servidor aceita solicitações do Hub de Agente Virtual no método POST api/relay. O URL do seu webhook é:

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

    O servidor aceita solicitações do Hub de Agente Virtual no método POST relayExchangeResponse. O URL do seu webhook é:

    https://[URL base]/relayExchangeResponse
    PHP

    O servidor aceita solicitações do Hub de Agente Virtual no método POST proxy.php. O URL do seu webhook é:

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

As etapas para determinar o terminal descritas nesta seção se aplicam apenas à integração de exemplo. Quando você criar seu próprio terminal, poderá ser qualquer coisa que atenda às necessidades da sua organização.

Configurar um script de chat simples no Studio

  1. Baixe este script de chat simples.
  2. Extraia o arquivo TextBotExchangeExample.xml para o seu computador.
  3. No Studio, clique em Arquivo > Importar do arquivo, selecione o arquivo extraído e clique em Abrir.
  4. Salvar o script. Lembre-se do nome que você deu ao script. Deixe o script aberto. Você voltará a ele em uma tarefa posterior.

Criar uma competência de chat e ponto de contato no CXone

Você precisa criar uma competênciaFechado Usado para automatizar a entrega de interações com base nas competências, habilidades e conhecimento do agente. e um ponto de contatoFechado O ponto de entrada que um contato de entrada usa para iniciar uma interação, como um número de telefone ou endereço de e-mail. de chat. O ponto de contato chama o script que você importou. É assim que o CXone encaminha os contatos para o seu agente virtual.

  1. No CXone, clique no seletor de aplicativos e selecioneACD.
  2. Clique em Configurações de Contato > Competências ACD e crie uma competência de chat. Você deve dar à competência um Nome e a atribua a uma Campanha. Você pode criar uma campanha para usar na integração de amostra. Você pode aceitar os padrões para todas as outras opções de competência.

  3. Vá para Configurações de Contato > Pontos de Contato e crie um pontos de contato com as seguintes configurações:

    • Tipo de mídia: Selecione Chat.
    • Script: Selecione o nome do script que você importou para usar com a integração de exemplo.
    • Competência: Selecione o nome da competência que você criou nesta tarefa.

  4. Depois de criar o ponto de contato, copie o URL do Ponto de Contato exibido na guia Detalhes. Cole-o em uma guia do seu navegador. Você usará esse URL em uma tarefa posterior para testar o script.

    A guia Detalhes do ponto de contato criado para testar o túnel proxy de amostra. O campo Ponto de contato exibe o URL que invoca o script.

Configurar a ação Textbot Exchange

Esta etapa configura o CXone para se comunicar com o terminal do túnel proxy de amostra.

  1. No Studio, abra o script de amostra que você importou, se ainda não estiver aberto.

  2. Clique duas vezes em uma das ações Textbot Exchange para abrir o Hub de Agente Virtual.

    O ícone para a ação Textbot Exchange. É um balão de chat com olhos de robô e uma antena no topo com os caracteres ABC embaixo.
  3. Clique Adicionar bot.
  4. Digite um Nome de agente virtual (Bot) e selecione Terminal Exchange Personalizado como Provedor de Bot.
  5. Clique em Avançar.
  6. Digite o URL do Webhook. Esse é o URL que você salvou depois de expor o terminal de túnel proxy.
  7. Clique em Avançar.
  8. Na página Voz, selecione Somente Texto em Opções de Integração de Voz e clique em Avançar.
  9. Na página Testar + Adicionar, clique em Começar com a intenção de boas-vindas. Testar outras opções, como enviar carga útil personalizada, conforme desejado. Se não houver erros, siga para a próxima tarefa. Se seu teste resultar em erros, revise as tarefas anteriores para verificar a configuração e a exposição do terminal do túnel proxy e a configuração no Hub de Agente Virtual.

Testar o script em uma janela de chat

Quando terminar de resolver os erros que ocorreram durante o teste da configuração da ação Textbot Exchange, você pode testar o script usando o URL do ponto de contatoFechado O ponto de entrada que um contato de entrada usa para iniciar uma interação, como um número de telefone ou endereço de e-mail. copiado em uma tarefa anterior.

  1. No Studio, abra o script de amostra que você importou.
  2. Clique em Depurar > Capturar script > Apenas próxima instância.
  3. Na guia do navegador em que você colou o URL do ponto de contato, digite uma mensagem no campo Insira seu Texto e clique em Enviar.

  4. No Studio, a janela Rastrear Saída é aberta. Ela mostra o progresso do script conforme você envia mensagens e o script responde.

    Clique em uma ação no painel principal na janela Trace Output .

    • A guia Variáveis mostra todas as variáveis que existem no script quando a ação selecionada é concluída. Ela também mostra o valor que cada variável tem nesse ponto do script.
    • A guia Propriedades mostra as propriedades da ação selecionada. Você pode usar isso para verificar a configuração atual da ação.
    A janela Rastrear Saída no Studio, mostrando os resultados do rastreamento do início do script do agente virtual do chat de amostra.
  5. Volte ao script e faça alterações, se necessário.
  6. Para acessar a ajuda online para uma ação, selecione-a na tela e pressione F1 em seu teclado. A página de ajuda online para cada ação descreve as propriedades e outras informações sobre como usar a ação em um script.
  7. Se você quiser recomeçar, clique em Encerrar chat, atualize a janela do navegador e repita este processo, começando pela etapa 2.