Implementar uma Integração de Agente virtual personalizado

Esta página descreve o processo geral que você deve seguir ao implementar uma integração de agente virtual personalizado. todos os ambientes e todas as integrações personalizadas são diferentes. Sua situação pode exigir tarefas adicionais não descritas aqui. É de sua responsabilidade entender o que sua integração requer e, caso sejam 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. Realize testes completos para garantir que 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 essa tarefa, você deve colocar o código do túnel proxy no lugar e executar os comandos que iniciam o código e expõem os endpoints. 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: ACD > Studio > Scripts do studio > Criar/Editar, Importar/Exportar, Depurar, Sobreposição de bloqueio; ACD > Studio > Record Prompts > Ativado; ACD > Studio > File Browser > Editar, Criar

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

  • Exporte os Scripts de um ambiente e importe-os para outro. Você pode querer criar uma pasta especificamente para os Scripts relacionados à sua integração de agente virtual personalizada.
  • Salve os scripts com novos nomes. Se você usar convenções de nomenclatura para gestão de versão, será necessário alterar os nomes dos scripts para movê-los do desenvolvimento para a produção. Studio não oferece suporte à alteração de nomes de Scripts. Para renomeá-los, você deve usar 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 Terminal é criado em Virtual Agent Hub.
  • Toda 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 em Virtual Agent Hub para verificar a conexão.

Configure a conexão entre NiCE CXone e seu Agente virtual

Permissões necessárias: ACD > Studio > Scripts do studio > Criar/Editar; Integrações > iniciar

A conexão entre seu agente virtual e NiCE CXone é a ação de agente virtual em seus Scripts de 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 Virtual Agent Hub e, em seguida, atribuindo-o a cada instância das ações do agente virtual no seu script.

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

As ações de agente virtual são VoiceBot Exchange e TextBot Exchange.

A Página de Configuração para o aplicativo Terminal de Troca Personalizada é 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: Supports a single authorization header. The header is sent with the ExternalIntegrationBotExchangeRequest request.
  • 2.0.0: Suporta múltiplos cabeçalhos DE autorização. Os cabeçalhos são enviados com a solicitação ExternalIntegrationBotExchangeRequest como pares de chave-valor.
  • 3.0.0: Oferece Suporte a múltiplos cabeçalhos DE autorização e StandardBot. Os cabeçalhos são enviados com a solicitação ExternalIntegrationBotExchangeRequest como pares de chave-valor.
  • 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 diferença principal é que a 3.0.0 adiciona suporte para StandardBot.

Configurar Versão DE integração 1.0.0

  1. Em NiCE CXone, clique no seletor de aplicativos Icon of three-by-three grid of white squares on a blue background e selecioneOutro > Connection Hub e, em seguida, clique em Virtual Agent Hub. Você também pode dar um duplo clique na ação de agente virtual em seu script Studio para iniciar Virtual Agent Hub.
  2. Clique Adicionar bot.
  3. Digite um Nome de Agente virtual (Bot) e selecione Terminal Exchange Personalizado como Provedor de bot.
  4. Clique em Avançar.
  5. Selecione Versão DE integração 1.0.0.

  6. Digite o URL DO webhook para o seu agente virtual. Esse é o terminal para o qual o script envia todas as solicitações.
  7. Se você estiver usando autorização com sua integração de agente virtual personalizado, insira o Cabeçalho DE autorização do seu serviço de agente virtual. O cabeçalho é enviado com a solicitação ExternalIntegrationBotExchangeRequest.
  8. 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.

  9. 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.

  10. Clique em Próx. na página Configuration.
  11. Preencha as páginas Voz e Transcrição no assistente Adicionar bot.
  12. Teste sua integração.
  13. Atribua o aplicativo de configuração Custom Exchange Endpoints às ações do agente virtual no seu script.

Configurar a Versão DE integração 2.0.0 e3.0.0

  1. Em NiCE CXone, clique no seletor de aplicativos Icon of three-by-three grid of white squares on a blue background e selecioneOutro > Connection Hub e, em seguida, clique em Virtual Agent Hub. Você também pode dar um duplo clique na ação de agente virtual em seu script Studio para iniciar Virtual Agent Hub.
  2. Clique Adicionar bot.
  3. Digite um Nome de Agente virtual (Bot) e selecione Terminal Exchange Personalizado como Provedor de bot.
  4. Clique em Próximo.
  5. Selecione Versão DE integração 2.0.0 ou 3.0.0.

  6. Digite o URL DO webhook para o seu agente virtual. Esse é o terminal para o qual o script envia todas as solicitações.
  7. Para enviar cabeçalhos com a 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, ignore esta etapa.

  8. Para incluir parâmetros em cada solicitação enviada ao serviço do agente virtual, clique em Adicionar Parâmetros DO terminal. Digite o Nome e o Valor do parâmetro. Repita essa etapa para adicionar mais Parâmetros.

  9. 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.

  10. Para usar a autenticação mTLS com sua integração personalizada de agente virtual, clique em Adicionar certificados de cliente de webhook e configure os detalhes do seu certificado.
  11. Para configurar a autenticação dinâmica com sua integração personalizada, clique em O Auth Required para alternar para Ativado e configure os campos obrigatórios.
  12. Clique em Próx. na página Configuration.
  13. Preencha as páginas Voz e Transcrição no assistente Adicionar bot.
  14. Testar sua integração.
  15. Atribua o aplicativo de configuração Custom Exchange Endpoints às ações de agente virtual no seu script.

Configurar autenticação mTLS com certificados de cliente

Você pode adicionar certificados de cliente e chaves ao seu aplicativo Custom Exchange Endpoints 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 Virtual Agent Hub, selecione o aplicativo Custom Exchange Endpoints que deseja modificar.

  2. Clique em Adicionar certificados de cliente de 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 precisar adicionar mais certificados de cliente, clique em Add Client Certificates e repita as etapas 2-5.

  8. Salve suas alterações.

Configurar Autenticação Dinâmica com OAuth para a Versão 2.0.0 ou 3.0.0

Se estiver usando a autenticação Dinâmica com sua integração personalizada, você pode ter 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 Virtual Agent Hub, selecione o aplicativo Custom Exchange Endpoints que deseja modificar.
  2. Clique em OAuth Necessário para alterná-lo para Ativado.
  3. Digite o URL do servidor de autorização no campo URL do OAuth.
  4. Selecione JSON ou Form URL Encode em Request Content Type. Este é o 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. Insira a chave Name e o Value. Repita esta etapa para adicionar mais parâmetros de solicitação.
  6. Clique em Adicionar OAuthCabeçalhos e insira os pares de chave-valor para quaisquer cabeçalhos que o seu servidor de autorização exigir que as solicitações incluam. Insira a chave Name e o valor Value. Repita esta etapa para adicionar mais parâmetros de cabeçalho.
  7. Para personalizar os cabeçalhos DE autorização enviados com solicitações ao seu provedor de agente virtual, clique em Autorização de Cabeçalho Personalizado para alterná-lo para Ativado e, em seguida:

    1. Enter um novo Nome do Cabeçalho DE autorização para alterar o nome da chave no par chave-valor do 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 Custom Exchange Endpoints para ser um agente virtual de voz ou um agente virtual 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 transcrição (fala em texto/STT) que você deseja usar.

A página Transcrição no assistente Custom Exchange Endpoints permite que você selecione se deseja que sua integração capture transcrições das conversas do agente virtual com os contatos.

  1. Em Virtual Agent Hub, adicione o aplicativo Custom Exchange Endpoint e complete a página de configuração para versão 1.0.0 ou versão 2.0.0/3.0.0.
  2. Clique em Próx. na página Configuration.
  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 então clique em Next. Pule para a etapa 10 desta seção.

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

  5. Em Opções de Transcription, selecione o serviço de fala em texto que você deseja usar.

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

  8. Clique em Avançar.
  9. Testar a integração do seu agente virtual, se desejar, ou clique em Adicionar para adicionar o aplicativo de configuração Custom Exchange Endpoints a Virtual Agent Hub.

Testar sua Integração de Agente virtual personalizado

Permissões necessárias: ACD > Studio > Studio Scripts > Criar/Editar; Integrations > iniciar

Esta etapa testa a conexão entre o NiCE CXone e o agente virtual. Garante que o agente virtual funcione da maneira esperada ao se comunicar com NiCE 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 em Virtual Agent Hub. Ao testar, 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.
  • Acione 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 DTMFClosed Tons de sinalização gerados quando um contato pressiona uma tecla do teclado do telefone..

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

  1. Em NiCE CXone, clique no seletor de aplicativos Icon of three-by-three grid of white squares on a blue background e selecioneOutro > Connection Hub e, em seguida, clique em Virtual Agent Hub. Você também pode dar um duplo clique na ação de agente virtual em seu script Studio para iniciar Virtual Agent Hub.
  2. Clique para selecionar o aplicativo de configuração para o agente virtual que deseja testar na lista à esquerda.
  3. No painel Testar, insira uma mensagem de teste no campo Digite uma mensagem e pressione Enter para enviá-la.

  4. 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.
  5. Clique em Mais opçõesUm ícone com três pontos empilhados verticalmente. para testar outros aspectos do seu agente virtual.

  6. Clique em Reset para iniciar seu teste novamente.
  7. Se você precisar fazer alterações com base nos resultados de seus testando, você pode:

    • Modificar os scripts do Studio para o agente virtual.
    • Modificar as configurações no aplicativo do agente virtual no Virtual Agent Hub.
    • Modificar as configurações do agente virtual no console do provedor. Clique no botão quadrado grande na página de propriedades do aplicativo em Virtual Agent Hub. O exemplo no início desta seção mostra o aplicativo Google Dialogflow CX com o botão do provedor. Ele tem o ícone An icon that has a square with an arrow overlaid on top of it. The arrow points from the center of the square to the top right corner of the square. para indicar que o link abre um site externo.
  8. Teste o agente virtual minuciosamente após cada alteração nos Scripts ou em qualquer configuração.
  9. Quando terminar de testar, clique em Fechar.

Atribua o Agente virtual a uma Ação de Studio

Permissões necessárias: ACD > Studio > Studio Scripts > Create/Edit

Quando o aplicativo do agente virtualClosed O significado ou a finalidade por trás do que um contato diz/digita; o que o contato deseja comunicar ou realizar. estiver configurado em Virtual Agent Hub, você precisa atribuí-lo à ação 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 VOICEBOTSTREAMação em seu script. Se ainda não o fez, adicione-a a partir da paleta Actions.
  3. Clique em Abrir editor na ação para abrir Virtual Agent Hub.
  4. Localize a ação do agente virtual no script e clique em Abrir editor na ação para abrir Virtual Agent Hub.

  5. Na coluna da esquerda, localize o perfil de agente virtual que você deseja atribuir à ação e clique na marca de seleção Um ícone de círculo com uma marca de seleção dentro dele. ao lado dele.

    Uma alternativa ao uso da marca de seleção é criar uma variável em seu script Studio. Use a variável para passar o nome do aplicativo do agente virtual para a propriedade ID do Agente virtual da ação Virtual Agent Hub que você está usando.

  6. Clique me Fechar.

Concluir os requisitos específicos do Canal

Permissões necessárias: ACD> Configurações de contato > Campanhas > Editar, Criar; ACD> Configurações de contato > pontos de contato > Editar, Criar; ACD> Configurações de contato > Competências > Criar, Editar, Atribuir Usuário; ACD> Configurações de contato > Perfis de chat > Criar, Editar; ACD> Digital Engagement > Configurações de canais

Configure o canalClosed Diversos meios de comunicação por voz e digitais que facilitam as interações com o cliente em uma central de contato. que os contatos usarão para iniciar as interações com seu agente virtual.

Para canais de voz ou chat do NiCE CXone:

Para canais Digital Experience (DX):

Se você usar uma convenção de nomenclatura como controle de versão com seus scripts do Studio, certifique-se de salvar 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:

  • Criando um perfil de chat para o chat ACD.
  • Configurar a opção de chat ou mensagem para digital channels, em que as conversas começam em outros sites, como Instagram.
  • Adicionando o chat ao seu site ou aplicativo móvel (chat de NiCE CXone e chat digital).

Testar o Script a Partir do ponto de contato

Permissões necessárias: ACD > Configurações de contato > Points of Contact > View, Edit

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

Os testes que você fez anteriormente no processo de implementação testaram a conexão entre o agente virtual e NiCE CXone. Os testes nesta etapa verificam toda a integração, desde o contato até NiCE CXone e o agente virtual.

  1. Em Studio, abra o script que o ponto de contato chama.
  2. Clique em Depurar > Captura Script > Somente Próxima instância.
  3. Iniciar uma interação. Como você a inicia varia de acordo com o canalClosed Diversos meios de comunicação por voz e digitais que facilitam as interações com o cliente em uma central de contato..Por exemplo:

    No Studio, a janela Rastrear Saída é aberta. Exibe 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 Trace Output.

    • A aba Variáveis mostra todas as variáveis que existem no script quando a ação selecionada está Concluído. Ela também mostra o valor que cada Variável contém 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 de cada ação descreve as propriedades e outras informações sobre o uso da 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.