CUSTOMEVENT

Esta página de ajuda é para Studio. Estas informações também estão disponíveis para Desktop Studio.

Dependências

Esta ação é encontrada na paleta de Ações API.

Tipos de script suportados

Um quadrado com uma linha saindo dele e indo em direção a três outros quadrados.

Icon of gray-green envelope

Ícone de balão de fala verde escuro

Icon of purple telephone handset

Ícone do símbolo de correio de voz na cor marrom-enferrujado, composto por dois círculos unidos por uma linha

Icon of pink document with lines of text

Ícone de um telefone celular verde com um balão de fala na tela

Icon of purple computer monitor with a mobile device overlapping its lower right corner

Genérico

E-mail Chat Telefone Correio de voz Item de trabalho SMS Digital

Propriedades de entrada

Estas propriedades definem dados que a ação usa durante a execução.

Propriedade

Descrição

Adicionar legenda

Insira uma frase curta que identifique exclusivamente esta ação no script. A legenda aparece na tela do script no ícone da ação.

Agente-alvo

O id do agente para o qual o evento personalizado está direcionado. O script Studio popula a variável AgentId após o evento OnAnswer para uma chamada de entrada. O evento personalizado é executado somente quando o AgentId estiver preenchido. Se você quiser enviar um evento personalizado antes da atribuição do agente, deverá fornecer um ID de agente ao campo TargetAgent.

Nome do evento

Enter o nome que você deseja para o evento personalizado. Vários eventos com o mesmo nome se sobrepõem. Somente o nome do evento mais recente é mantido. Este campo diferencia maiúsculas de minúsculas.

PersistInMemory

Se um evento for executado quando um agente estiver com a sessão terminada e você quiser que ele receba o evento ao fazer login novamente, defina este valor como true. Caso contrário, defina como false.

Dados

Carga útil de dados para este evento.

Condições de Ramificação de resultado

As condições de ramificação de resultado permitem que você crie ramificações no seu script para tratar diferentes resultados quando uma ação é executada.

Condição

Descrição

Padrão Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.
OnAgentNotConnected Caminho percorrido se o agente de destino estiver não conectado.

Exemplo de script

Este é um exemplo para mostrar como essa ação pode ser usada em Scripts. Ele não é voltado para um script inteiro. Pode ser necessário um script adicional.

Example script using the CUSTOMEVENT action

Neste exemplo de script, as ramificações exemplificam três cenários nos quais você geraria um evento personalizado:

  • Branch 1: Iniciando e recebendo um evento personalizado antes de qualquer interação do agente. O evento personalizado é recebido pelo loop get-custom-event quando um contato pressiona 1.

  • Ramificação 2: Iniciando e recebendo um evento personalizado antes de qualquer interação do agente. O evento personalizado é recebido pelo loop get-custom-event quando um contato pressiona 2. Além disso, outro evento personalizado é gerado após o Reqagent disparar e antes de o agente atender a chamada.

  • Ramificações 2 e 3: Iniciando e recebendo um evento personalizado após um agente atender a chamada.

Criar Eventos personalizados via API

Você também pode criar um evento personalizado com a API custom-event Icon of dark gray square with an arrow pointing out of its upper right corner. Isso pode ser necessário se a ação CustomEvent não atender aos requisitos do seu caso de uso. Como os serviços normalmente já consomem o fluxo de evento do agente, esse pode ser um método conveniente de compartilhar dados sem a necessidade de implementar seu próprio terminal personalizado. Isso é particularmente relevante para aplicativos de escopo pequeno ou microsserviços.

O uso da API é semelhante à ação Studio, exceto que você usa parâmetros em vez de propriedades. O uso das APIs do NiCE CXone também exige que você implemente a autenticação da API. Ao usar a API, certifique-se de:

  • Nomeie o evento.

  • Atribuir um agente de destino no parâmetro agentId ou na propriedade agente-alvo da ação Studio. Você pode usar o ID a partir da variável AgentId. Isto é preenchido automaticamente após o evento OnAnswer. Se desejar enviar um evento personalizado antes de um Agente ser atribuído, ainda assim você deve fornecer um id do agente.
  • Defina o campo persistInMemory. Se o agente estiver com a sessão terminada, isso determina se ele receberá o evento após o novo login.
  • Preencha o campo Data, que é a carga útil como uma string.
  • Consuma o evento personalizado com a API get-next-event Icon of dark gray square with an arrow pointing out of its upper right corner ou a ação Obter Próximo evento Studio.

Veja a seguir um exemplo de criação de um evento personalizado via API:

Exemplo de curl:

curl -X PUT "https://api-$AREA.$DOMAIN/incontactapi/services/v30.0/agents/$AGENT_ID/custom-event?eventName=From_Postman&persistInMemory=false&data=Sent_from_Postman"

Tipo de solicitação: PUT

Campos:

Parâmetro Tipo Detalhes
agentId Comando O valor da id do agente que identifica o agente de destino.
eventName Comando O nome do evento. Ele deve ser usado por quaisquer consumidores do evento.
persistInMemory Booleano Se o agente identificado por agentId não estiver com sessão iniciada no momento, o evento será ignorado ou permanecerá para o agente assim que ele iniciar sessão novamente.
data Comando Qualquer string de dados.