AI Agents (Cognigy) Extensão da API sinal e TMS para escalonar ou encerrar Voz Interactions
The extensão AI Agents (Cognigy) Sinal e API TMS permite que seu bot de voz AI Agents (Cognigy) coordene a transição de interações e o processamento de transcrições dentro do CXone. A extensão oferece duas funcionalidades principais:
-
Sinal: Envia uma solicitação de API de Sinal do CXone que instrui o CXone a escalar a interação para um agente em tempo real ou encerrar a conversa.
-
TMS API: Envia a transcrição da conversa para o CXone Transcript Management Service (TMS) para que o CXone possa gerar resumos de autoatendimento e oferecer suporte a relatórios e análises posteriores.
Juntas, esses recursos garantem que as interações de voz sejam transferidas de forma limpa do bot para o CXone e que os dados de transcrição sejam preservados para processamento pelo CXone.
A extensão atual, distribuída como um arquivo .gz, será substituída por um nó AI Agents (Cognigy) nativo para simplificar a implantação. Quando o nó nativo estiver disponível, siga as instruções de migração fornecidas neste tema.
Se você já estiver usando a extensão, deverá planejar remover a extensão e mudar para o nó nativo quando ele for lançado. A atualização não é urgente, mas é recomendada como parte da manutenção padrão e para garantir a compatibilidade com futuros recursos.
Este tema explica como habilitar o acesso, carregar a extensão e configurá-la em um Fluxo Cognigy AI.
Pré-requisitos
Antes de começar, certifique-se do seguinte:
-
Você deve ter o Cognigy AI habilitado para o seu locatário. Para saber como habilitar o aplicativo e acessá-lo por meio do SSO, consulte Habilitar Aplicativo AI Agents (Cognigy) e acesso SSO.
-
Um projeto AI Agents (Cognigy) com permissões para fazer upload de extensões
-
Um canal de voz conectado ao CXone usando SIP Backchannel
-
Acesso ao pacote de extensão (.gz) da API Sinal e TMS pelos Serviços Profissional.
-
CXone Studio scripts configurados:
-
Principal script de canal de retorno SIP
-
Script de canal de retorno gerado
-
CXone token / script Integration Hub
-
A geração de token do CXone é um script recomendado, mas não obrigatório. É necessária uma licença Integration Hub para gerar um token do CXone criptografado. Sem essa licença, o token do CXone ainda pode ser gerado; no entanto, permanecerá em texto simples, o que é menos seguro e não recomendado para ambientes de produção.
-
Entre em contato com Serviços Profissionais para obter os modelos de scripts completos do Studio. Demo scripts são simplificados e não se destinam à produção.
-
-
Os cabeçalhos SIP estão disponíveis na carga útil da solicitação CXone → AI Agents (Cognigy)
-
Configuração de Integration Hub e CXone Studio concluída.
A configuração de Integration Hub e de CXone Studio está fora do escopo desta tarefa e é fornecida separadamente pelos Serviços Profissionais.
Carregar a Extensão de API do Sinal e TMS em um Fluxo
-
Abra seu projeto AI Agents (Cognigy).
-
Na navegação à esquerda, selecione Manage > Extensões.
-
Selecione Upload Ramal.
-
Procure e selecione o arquivo .gz da extensão de API do Sinal e TMS. Selecione Open.
Uma mensagem de sucesso confirma que a extensão foi instalada e aparece em (por exemplo, Sinal CXone).
Use a Extensão de API do Sinal e TMS em um Fluxo
-
Em AI Agents (Cognigy), selecione Build > Fluxos.
-
Na lista, selecione o Fluxo que deseja editar, por exemplo, SayHelloAndHandover.
-
Se o projeto contiver múltiplos fluxos, selecione Main Flow no seletor de Fluxo na parte superior. O fluxo é aberto na visualização Chart, onde você pode adicionar e configurar nós.
A extensão requer metadados SIP para identificar a interação do CXone.
-
No ramo On First Time do Fluxo, adicione um nó Adicionar ao Contexto.
-
Armazene a carga útil da solicitação SIP recebida no contexto, por exemplo:
-
Chave de contexto: sipBody
-
Valor: corpo da solicitação SIP recebida
Esses dados SIP são reutilizados posteriormente ao enviar sinais para o CXone.
-
-
Adicione a lógica de bot necessária, como nós Say ou tratamento de intenção.
-
Verifique se o bot se comporta conforme o esperado antes da escalação ou do encerramento.
A etapa não é específica para a extensão, mas é necessária para uma interação de voz completa.
-
Na ramificação Afterwards do Fluxo, adicione um nó Get Transcript. O nó Get Transcript coleta a transcrição e a armazena na variável de transcrição que você definiu.
-
Configure o nó Get Transcript:
-
Localização da loja: Entrada
-
Chave de entrada: transcrição
-
Limite: Conforme necessário (por exemplo, 25 turnos)
O nó Get Transcript somente captura a transcrição no fluxo. A transcrição é enviada ao CXone TMS pelo nó sair da Interação na próxima etapa.
-
-
Adicione um nó de extensão sair da Interação após o nó Obter Transcrição.
-
No Fluxo editor, selecione o ícone de mais (+) onde o nó deve ser adicionado.
-
Selecione a guia Extensões > categoria CXone > Exit Interaction. O nó de extensão é adicionado ao seu fluxo.
-
-
Abra o nó de extensão Exit Interaction e selecione Edit Node, configure os seguintes campos:
Nome do campo
Descrição
Ambiente Ambiente CXone. Selecione Other ao usar uma URL base personalizada do CXone. URL base do ambiente A URL base da API do CXone (por exemplo, https://cognigy-na1.nicecxone.com Entregar Ação
Selecione Escalate to Agent ou encerrar conversa. Número da unidade de negócios
ID da unidade de negócios do CXone. Normalmente mapeado a partir dos Cabeçalhos SIP, por exemplo: {{context.sipBody.headers[\"X-InContact-BusNo\"]}}. Id do contato principal
Id do contato primário do CXone a partir dos Cabeçalhos SIP.
Id do contato gerado
Id do contato gerado ou filho a partir dos Cabeçalhos SIP.
Conexão CXone Conexão pré-configurada do CXone usada para autenticar solicitações de API do Sinal e do TMS. Quando você usa o modelo fornecido pela equipe de Serviços Profissionais, os campos obrigatórios de interação de sair—como Número da Unidade de negócios, Id do contato Principal, Id do contato Gerado e Conexão CXone—são pré-preenchidos no modelo. Você deve mesmo assim revisar os valores para garantir que eles correspondam ao seu ambiente e à configuração de integração.
-
O nó sair da Interação envia a variável de transcrição para o CXone usando a API TMS.
-
A CXone processa a transcrição e a disponibiliza para aplicativos subsequentes. A geração de um resumo de autoatendimento é opcional e, quando habilitada, é criada com base no conteúdo da transcrição. As variáveis baseadas na transcrição são armazenadas na CXone para fins de relatórios e análises subsequentes.
-
Selecione Salvar Nó.
Como o Sinal e a Extensão de API do TMS Funcionam
As extensões de API do Sinal e do TMS funcionam juntas para garantir que uma interação seja devidamente finalizada no CXone e que os dados da transcrição estejam disponíveis para uso posterior.
Antes do início desse processo, os metadados SIP e a transcrição já devem estar disponíveis. Depois que estiverem disponíveis, o fluxo principal funciona da seguinte maneira:
-
O nó sair da Interação aciona ambas as API em uma sequência definida:
-
TMS API
-
Envia a transcrição para o CXone.
-
Armazena dados baseados em transcrição para reporting e analytics.
-
Gera opcionalmente um resumo de autoatendimento se esse recurso estiver habilitado.
-
-
Signal API
-
Envia uma solicitação ao CXone para escalar a interação ou encerrá-la.
-
Usa os metadados SIP capturados anteriormente para identificar a interação correta do CXone.
-
-
Demo Scripts
Script de canal de retorno SIP principal
Script de canal de retorno gerado
Token do CXone ou Integration Hub script