Implementar uma integração de agente virtual personalizada

Esta página descreve o processo geral que você deve seguir ao implementar uma integração de agente virtual personalizada. Cada ambiente e cada integração personalizada é diferente. Sua situação pode exigir tarefas adicionais não descritas aqui. É sua responsabilidade entender o que sua integração requer e, se forem necessárias tarefas adicionais, onde elas se encaixam no processo descrito nesta página.

Complete cada uma dessas tarefas na ordem indicada.

Configurar o agente virtual e o servidor de autorização

Configure o agente virtual no ambiente do provedor. Faça testes completos para garantir que tudo funcione conforme o esperado.

Se sua integração usar autenticação dinâmica, configure o servidor de autorização.

Configurar o terminal do túnel proxy

Para concluir esta tarefa, você deve implantar o código do túnel proxy e executar os comandos que iniciam o código e expõem os terminais. As etapas e os comandos exatos necessários serão diferentes para cada ambiente.

Configurar os scripts necessários do Studio

Permissões necessárias: Aplicativos > Studio > Scripts > Criar/Editar, Importar/Exportar, Depurar, Bloquear Substituição; Aplicativos > Studio > Prompts > Gravar; Aplicativos > Studio > Navegador de Arquivo > Editar, Criar

Certifique-se de que todos os scripts do Studio necessários estejam em seu ambiente de produção. Você pode precisar:

  • Exportar os scripts de um ambiente e importá-los em outro. Você pode criar uma pasta especificamente para scripts relacionados à sua integração de agente virtual personalizada.
  • Salve os scripts com novos nomes. Se você usar convenções de nomenclatura para controle de versão, altere os nomes dos scripts para movê-los do desenvolvimento para a produção. O Studio não aceita a alteração de nomes de scripts. Para renomeá-los, use a opção Arquivo > Salvar como.

Certifique-se de que as ações do agente virtual estejam configuradas corretamente. Isso significa que:

  • O aplicativo Custom Exchange Endpoint foi criado no Hub de Agente Virtual.
  • Cada ação de agente virtual em seus scripts tem o aplicativo Custom Exchange Endpoint atribuído a ela.
  • A conexão entre o script e o agente virtual funciona conforme o esperado depois que você move o script para produção. Faça alguns testes no aplicativo Custom Exchange Endpoint no Hub de Agente Virtual para verificar a conexão.

Configurar a conexão entre o CXone e seu agente virtual

Permissões necessárias: Aplicativos > Studio > Scripts > Criar/Editar

A conexão entre o seu agente virtual e o CXone é a ação de agente virtual em seus scripts do Studio. A ação deve ser configurada com os detalhes necessários para que os dois sistemas possam se comunicar. Você faz isso criando um aplicativo de configuração no Hub de Agente Virtual e, em seguida, atribuindo-o a cada instância das ações de agente virtual em seu script.

Você só precisa concluir esta tarefa uma vez, mesmo que tenha mais de uma ação de agente virtual em seu script.

As ações do agente virtual são:

A página de configuração do aplicativo Custom Exchange Endpoint é diferente dependendo da versão de integração que você está usando. Siga as etapas na seção abaixo referente à sua versão. As diferenças entre as versões são:

  • 1.0.0: Aceita um único cabeçalho de autorização. O cabeçalho é enviado com a solicitação ExternalIntegrationBotExchangeRequest.
  • 2.0.0: Aceita vários cabeçalhos de autorização. Os cabeçalhos são enviados com a solicitação ExternalIntegrationBotExchangeRequest como pares de chave-valor.
  • 3.0.0: Aceita vários cabeçalhos de autorização e StandardBot. Os cabeçalhos são enviados com a solicitação ExternalIntegrationBotExchangeRequest como pares de chave-valor.
  • As versões de integração 1.0.0 e 2.0.0 serão descontinuadas em uma versão futura. A versão 3.0.0 é a versão preferida para usar com integrações de agentes virtuais personalizados. Se você usa atualmente a versão 1.0.0 ou 2.0.0, planeje o upgrade para 3.0.0. A versão 3.0.0 é quase idêntica à versão 2.0.0. A principal diferença é que a 3.0.0 adiciona suporte para StandardBot.

Configurar a versão de integração 1.0.0

  1. No Studio, abra ou crie um script e adicione uma ação de agente virtual, se ainda não contiver uma.
  2. Clique duas vezes na ação do agente virtual para abrir Hub de Agente Virtual .
  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. Selecione Versão de Integração1.0.0.

  7. Digite o URL do Webhook para o seu agente virtual. Esse é o terminal para o qual o script envia todas as solicitações.
  8. Se você estiver usando autorização com sua integração de agente virtual personalizada, insira o cabeçalho de autorização do seu serviço de agente virtual. O cabeçalho é enviado com a solicitação ExternalIntegrationBotExchangeRequest.
  9. Para incluir parâmetros com cada solicitação enviada ao serviço de agente virtual, clique em Adicionar Parâmetros do Terminal. Digite o Nome e o Valor do parâmetro. Repita esta etapa para adicionar mais parâmetros.

  10. Para alterar o Limite de Tempo padrão, insira o número de milésimos de segundo que o script espera para que o serviço de agente virtual responda antes de atingir o limite de tempo. O padrão é 10000.

  11. Clique em Avançar na página Configuração.
  12. Preencha as páginas Voz e Transcrição no assistente Adicionar Bot.
  13. Teste sua integração.
  14. Atribua o aplicativo de configuração Pontos de Extremidade Personalizados do Exchange às ações do agente virtual em seu script.

Configurar as versões de integração 2.0.0 e 3.0.0

  1. No Studio, abra ou crie um script e adicione uma ação de agente virtual, se ainda não contiver uma.
  2. Clique duas vezes na ação do agente virtual para abrir Hub de Agente Virtual .
  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. Selecione Versão de Integração 2.0.0 ou 3.0.0.

  7. Digite o URL do Webhook para o seu agente virtual. Esse é o terminal para o qual o script envia todas as solicitações.
  8. Para enviar cabeçalhos com o URL do webhook, clique em Adicionar Cabeçalhos Personalizados. Isso inclui cabeçalhos de autorização. Digite o Nome e o Valor do cabeçalho. Repita esta etapa para adicionar mais cabeçalhos.

    Se você estiver usando a autenticação dinâmica OAuth, pule esta etapa.

  9. Para incluir parâmetros com cada solicitação enviada ao serviço de agente virtual, clique em Adicionar Parâmetros do Terminal. Digite o Nome e o Valor do parâmetro. Repita esta etapa para adicionar mais parâmetros.

  10. Para alterar o Limite de Tempo padrão, insira o número de milésimos de segundo que o script espera para que o serviço de agente virtual responda antes de atingir o limite de tempo. O padrão é 10000.

  11. Para usar a autenticação mTLS com sua integração de agente virtual personalizado, clique em Adicionar certificados de cliente do webhook e configure os detalhes do seu certificado.
  12. Para configurar a autenticação dinâmica com sua integração personalizada, clique em OAuth Necessário para ativá-lo e configure os campos obrigatórios.
  13. Clique em Avançar na página Configuração.
  14. Preencha as páginas Voz e Transcrição no assistente Adicionar Bot.
  15. Teste sua integração.
  16. Atribua o aplicativo de configuração Pontos de Extremidade Personalizados do Exchange às ações do agente virtual em seu script.

Configurar a autenticação mTLS com certificados de cliente

Você pode adicionar certificados de cliente e chaves ao seu aplicativo Pontos de Extremidade Personalizados do Exchange para usar a autenticação mTLS com sua integração personalizada.

Antes de começar, você deve ter um certificado e uma chave privada no formato PEM.

  1. No Hub de Agente Virtual, selecione o aplicativo Pontos de Extremidade Personalizados do Exchange que deseja modificar.

  2. Clique em Adicionar certificados de cliente webhook.

  3. Digite um Nome de certificado opcional. Pode ser qualquer palavra ou frase que identifique o certificado.

  4. Copie o texto simples codificado do arquivo PEM do certificado e cole-o no campo Certificado.

  5. Copie o texto simples codificado da chave privada do arquivo PEM e cole-o no campo Chave privada.

  6. Insira a senha do certificado.

  7. Se você precisa adicionar mais certificados de cliente, clique em Adicionar certificados de cliente e repita as etapas 2-5.

  8. Salve suas alterações.

Configurar a autenticação dinâmica com OAuth para a versão 2.0.0 ou 3.0.0

Se você estiver usando a autenticação dinâmica com sua integração personalizada, pode usar o aplicativo Custom Exchange Endpoint para gerenciar seus tokens. Se você ativar essa opção, isso substituirá o valor do cabeçalho personalizado recuperado pelo servidor de autorização.

  1. No Hub de Agente Virtual, selecione o aplicativo Pontos de Extremidade Personalizados do Exchange que deseja modificar.
  2. Clique em OAuth Necessário para ativá-lo.
  3. Digite o URL do servidor de autorização no campo URL do OAuth.
  4. Selecione JSON ou Form URL Encode em Tipo de conteúdo da solicitação. Esse é tipo de corpo das solicitações OAuth.
  5. Clique em Adicionar Solicitação OAuth e insira os pares de chave-valor que formam o corpo da solicitação de autenticação. Isso inclui coisas como segredos de API ou credenciais de clientes. Digite o Nome e o Valor da chave. Repita esta etapa para adicionar mais parâmetros de solicitação.
  6. Clique em Adicionar Cabeçalhos OAuth e insira os pares de chave-valor para quaisquer cabeçalhos que seu servidor de autorização exige que as solicitações contenham. Digite o Nome e o Valor da chave. Repita esta etapa para adicionar mais parâmetros de cabeçalho.
  7. Para personalizar os cabeçalhos de autorização enviados ao seu provedor de agente virtual, clique em Autorização de Cabeçalho Personalizado para ativá-la e:

    1. Digite um novo Nome de Cabeçalho de Autorização para alterar o nome da chave no par de chave-valor para o cabeçalho de autorização. O padrão é Autorização.
    2. Digite um novo Prefixo de Valor de Cabeçalho de Autorização para alterar o prefixo enviado com o valor do cabeçalho. O padrão é Portador.
  8. Para personalizar o tempo de duração do token de autorização antes de expirar, digite um novo Tempo de Validade da Autenticação. O padrão é 0.

  9. Selecione uma opção da lista suspensa Selecionar Certificado OAuth para indicar se você quiser usar um certificado com seu servidor de autorização OAuth. Se você quiser usar um certificado, escolha Usar certificado de cliente webhook ou Adicionar novo certificado de cliente para o servidor de autenticação.

  10. Clique em Salvar.

Configurar opções de voz e transcrição

A página Voz permite configurar o aplicativo Pontos de Extremidade Personalizados do Exchange para ser um agente virtual de voz ou de texto. Para agentes virtuais de texto, não há configurações adicionais a serem definidas. Para agentes virtuais de voz, você pode selecionar:

  • O tipo de integração de voz que você está fazendo.
  • O serviço de conversão de texto em fala (TTS) que você quer usar.
  • O serviço de transcrição (conversão de fala em texto/STT) que você quer usar.

A página Transcrição no assistente Pontos de Extremidade Personalizados do Exchange permite selecionar se você quer que sua integração capture transcrições das conversas do agente virtual com contatos.

  1. No Hub de Agente Virtual, adicione o aplicativo Custom Exchange Endpoint e preencha a página de configurações para a versão 1.0.0 ou versão 2.0.0/3.0.0.
  2. Clique em Avançar na página de configurações.
  3. Se você estiver configurando uma integração de agente virtual de texto, selecione Somente texto na página Voz em Opções de integração de voz e clique em Avançar. Pule para a etapa 10 desta seção.

  4. Se você estiver configurando um agente virtual de voz, selecione a opção do tipo de integração de voz que você está configurando na lista da página Voz em Opções de integração de voz.

  5. Se você estiver configurando uma integração com um canal de retorno SIP ou uma conexão de telefonia personalizada, clique em Avançar e pule para a etapa 10 desta seção.
  6. Em Opções de texto para fala, selecione Usar CXone Cloud TTS. Essa é a única opção para integrações de agentes virtuais personalizadas. Então, você pode ignorar o texto na página sobre desmarcar a caixa de seleção e selecionar a opção de usar o serviço TTS do provedor de agente virtual.

  7. Selecione o Fornecedor de TTS que você quer usar com a sua integração personalizada. As opções são os fornecedores que o CXone Cloud TTS atualmente suporta.
  8. Em Opções de transcrição, selecione o serviço de conversão de fala em texto que você quer usar.

  9. Clique em Avançar.
  10. Na página Transcrição, selecione a opção para se você quer capturar as transcrições de conversas do agente virtual.

  11. Clique em Avançar.
  12. Teste sua integração de agente virtual se quiser ou clique em Adicionar para adicionar o aplicativo de configuração Pontos de Extremidade Personalizados do Exchange ao Hub de Agente Virtual.

Testar sua integração de agente virtual personalizada

Permissões necessárias: Aplicativos > Studio > Scripts > Criar/Editar

Esta etapa testa a conexão entre o CXone e o agente virtual. Ela garante que o agente virtual funcione da maneira que você espera ao se comunicar com o CXone.

Você pode testar muitos aspectos do seu agente virtual para garantir que tudo funcione conforme o esperado. Você pode executar testes na página de propriedades do aplicativo do agente virtual no Hub de Agente Virtual. Você pode:

  • Verificar se o aplicativo do agente virtual está configurado corretamente para se comunicar com o provedor do agente virtual.
  • Adicionar a carga útil personalizada JSON para testar a manipulação de dados da carga útil personalizada do agente virtual.
  • Adicionar um evento de intenção de boas-vindas para testar como o agente virtual inicia uma conversa.
  • Acionar um evento de intenção personalizada para testar quaisquer eventos personalizados que você criou para seu agente virtual.
  • Acionar um evento de tempo limite para testar como o agente virtual responde quando o contato expira.
  • Testar como o agente virtual lida com a entrada DTMFFechado Tons de sinalização gerados quando um usuário pressiona ou toca em uma tecla do teclado do telefone..

A imagem a seguir é um exemplo da página de propriedades de um aplicativo de agente virtual no Hub de Agente Virtual. Mostra as guias Configuração e Voz e o painel Teste.

  1. No Studio, abra ou crie um script e adicione uma ação de agente virtual, se ainda não contiver uma.
  2. Clique duas vezes na ação do agente virtual para abrir Hub de Agente Virtual .
  3. Clique para selecionar o aplicativo de configuração para o agente virtual que deseja testar na lista à esquerda.
  4. No painel Teste, insira uma mensagem de teste no campo Digite uma mensagem e pressione Enter para enviá-la. Você também pode clicar em Microfone Um ícone na forma de um microfone. e fale no microfone do seu computador.

  5. Clique em Iniciar com intenção de boas-vindas para iniciar uma conversa de teste desde o início. O agente virtual responde com sua mensagem de boas-vindas padrão. Você pode inserir mensagens de teste.
  6. Clique em Mais opções Um ícone com três pontos empilhados verticalmente. para testar outros aspectos do seu agente virtual.

  7. Clique em Reset e reinicie o teste.
  8. Se você precisar fazer alterações com base nos resultados de seus testes, você pode:

    • Modificar os scripts do Studio para o agente virtual.
    • Modificar as configurações no aplicativo do agente virtual no Hub de Agente Virtual.
    • Modificar as configurações do agente virtual no console do provedor. Clique no botão quadrado grande na página de propriedades do aplicativo no Hub de Agente Virtual. O exemplo no início desta seção mostra o aplicativo Google Dialogflow CX com o botão do provedor. Ele tem o Ícone que tem um quadrado com uma seta sobreposta. A seta aponta do centro do quadrado para o canto superior direito do quadrado. ícone para indicar que o link abre um site externo.
  9. Teste o agente virtual após cada alteração nos scripts ou em qualquer configuração.
  10. Quando termminar de testar, clique em Fechar.

Atribuir o agente virtual uma ação Studio

Permissões necessárias: Aplicativos > Studio > Scripts > Criar/Editar

Quando o aplicativo de agente virtualFechado O significado ou propósito por trás do que um contato diz/digita; o que o contato quer comunicar ou alcançar. está instalado e configurado no Hub de Agente Virtual, você precisa atribuí-lo às ações de agente virtual em seu script. Isso conecta a ação e o script ao seu provedor de agente virtual.

  1. Dentro Studio, abra o script que deseja modificar.
  2. Localize a ação do agente virtual no script e clique duas vezes nele para abrir Hub de Agente Virtual.

  3. Na coluna da esquerda, localize o agente virtual que você quer atribuir à ação e clique na opção de seleção Um ícone de círculo com uma marca de seleção dentro dele. ao lado dele.
  4. Clique em Fechar.

Concluir os requisitos específicos do canal

Permissões necessárias: Atendimento de Contatos > ACD > Pontos de Contato > Editar, Criar; Atendimento de Contatos > ACD > Perfis de Chat > Editar, Criar; Global > Configurações do Usuário > Competências > Editar, Criar; Global > Configurações do Usuário > Campanhas > Editar, Criar; Global > Configurações do Usuário > Usuários > Editar, Criar;

Configure o canalFechado Uma maneira de os contatos interagirem com agentes ou bots. Um canal pode ser voz, e-mail, chat, mídia social e assim por diante. que os contatos usarão para iniciar as interações com seu agente virtual.

Para canais de voz ou chat do CXone:

Se você usa uma convenção de nomenclatura como controle de versão com seus scripts do Studio, salve o seu script com seu nome de produção antes de atribuí-lo ao ponto de contato.

Certifique-se de ter concluído todos os requisitos para o seu canal, incluindo itens como:

Testar o script no ponto de contato

Permissões necessárias: Tratamento de contatos > ACD > Pontos de Contato > Visualizar, Editar

Quando o 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 email. está configurado, você precisa testar seu script começando pelo ponto de contato. Você pode usar o rastreamento de script para verificar a eficácia do seu script e identificar os problemas que surgirem.

O teste que você fez anteriormente no processo de implementação testou a conexão entre o agente virtual e o CXone. O teste nesta etapa verifica toda a integração, desde o contato pelo CXone até o agente virtual.

  1. No Studio, abra o script que o ponto de contato chama.
  2. Clique em Depurar > Capturar scriptApenas próxima instância.
  3. Inicie uma interação. Como você a inicia varia de acordo com o canalFechado Uma maneira de os contatos interagirem com agentes ou bots. Um canal pode ser voz, e-mail, chat, mídia social e assim por diante.. Por exemplo:

    No Studio, a janela Rastrear Saída é aberta. Ela mostra o progresso do script conforme você digita as respostas e o agente virtual responde.

  4. Clique em uma ação no painel principal na janela Rastrear Saída.

    • A guia Variáveis mostra todas as variáveis que existem no script quando a ação selecionada é concluída. 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.
  5. Volte ao script e faça alterações, se necessário.
  6. Selecione uma ação e pressione F1 no teclado para acessar a ajuda online para essa ação. 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.