CUSTOMEVENT
Esta página de ajuda é para Studio. Estas informações também estão disponíveis para Desktop Studio.
|
|
Cria um evento personalizado por meio do qual você pode entregar dados exclusivos como uma sequência a um agente específico. Eles podem ser gerados em resposta a uma ação relacionada ao agente, como OnAnswer. Eles também podem ser gerados antes que um agente seja atribuído, desde que TargetAgent esteja preenchido nas propriedades dessa ação. O evento personalizado gerado entra no fluxo de eventos do agente. Para receber um evento personalizado, associe-se à sessão de agente para escutar eventos, por exemplo, usando o paradigma get-next-event. Os eventos personalizados são úteis se os eventos existentes não se adequarem exatamente ao seu caso de uso. |
Dependências
Esta ação é encontrada na paleta de Ações API.
Tipos de script suportados
|
|
|
|
|
|
|
|
|
|
Genérico |
Chat | Telefone | Correio de voz | Item de trabalho | SMS |
|
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.
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.
Exibir exemplo de carga útil
{ "sessionId": "aUF6WkZJeW1nNno4NUp1eEhwZkxGdVgzaUJIRjIyMWlkaUQ2NkN0ejN0VkFyODQ4UFBZV3BiOVhRUT09", "events": [ { "IISHost": "AOA-B32COR01", "VCHost": "AOA-B32COR01", "type": "CustomEvent", "eventName": "This can be anything", "data": "Menu Press 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.
Exibir exemplo de carga útil
Carga útil antes de qualquer interação com o agente:
{ "sessionId": "NGVFOEd4UmJIdnlGWCtLblFEanRRSldtU2hDcXgxc1JhSUVHZ0NKNXdBSVRxa0F3MjhiOCtQM2E=", "events": [ { "IISHost": "AOA-B32COR01", "VCHost": "AOA-B32COR01", "type": "CustomEvent", "eventName": "This can be anything", "data": "Menu Press 2" { ] }Carga útil depois que Reqagent é acionado e antes que o agente atenda a chamada:
{ "sessionId": "NGVFOEd4UmJIdnlGWCtLblFEanRRSldtU2hDcXgxc1JhSUVHZ0NKNXdBSW4xeThiR0M2R1FBYlBhZz09", "events": [ { "IISHost": "AOA-B32COR01", "VCHost": "AOA-B32COR01", "type": "CustomEvent", "eventName": "This can be anything", "data": "Menu Press 2 and post reqAgent" { ] } -
Ramificações 2 e 3: Iniciando e recebendo um evento personalizado após um agente atender a chamada.
Exibir exemplo de carga útil
{ "sessionId": "aktmZEY1aFpDWlVwM0FzenhzTHZ2TnhJanpsZjR5SXhsekYwaUN2TjFYbUcwOW82cjRsZVdIc1FKdz09", "events": [ { "IISHost": "AOA-B32COR01", "VCHost": "AOA-B32COR01", "Type": "CallContactEvent", "ContactID": "510965166955", "MasterID": "510965166955", "Status": "Active", "OriginalState": "False", "CallType": "Regular", "DNIS": "", "ANI": "", "Skill": "23097992", "IsInbound": "True", "StartTimeUTC": "2024-07-12T15:46:38.000Z", "StartTime": "2024-07-12T15:46:38.000Z", "LastStateChangeTimeUTC": "2024-07-12T15:47:11.000Z", "LastStateChangeTime": "2024-07-12T15:47:11.000Z", "ScreenPopUrl": "", "DisconnectCode": "NA", "IsLogging": "False", "Timeout": "", "AllowDispositions": "True", "Label": "", "IsLinked": "False", "TimeZones": "", "FinalState": "False", "OtherInformation": "", "OtherInformationNewFormat": "", "BlendingToSkillName": "", "DeliveryType": "None", "CustomData": "", "ComplianceRecord": "False", "ConfirmationRequired": "False", "ParentContactId": "0", "OmniGroupId": "0", "ExternalId": "", "AnsMachineOverride": "False", "AnsMachineOverrideEndTime": "", "CustomerCardUrl": "", "InteractionId": "6a006eee-03d3-49fd-8aa9-614482684721", "IsRequireManualAccept": "False", "PhoneCallRefusalTimeOut": "45", "FaxMachineOveride": "False" }, { "IISHost": "AOA-B32COR01", "VCHost": "AOA-B32COR01", "type": "CustomEvent", "eventName": "This can be anything", "data": "This is a sample message after onAnswer" }, { "IISHost": "AOA-B32COR01", "VCHost": "AOA-B32COR01", "Type": "Mute", "AgentMuted": "True" } ] }
Criar Eventos personalizados via API
Você também pode criar um evento personalizado com a API custom-event
. 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.
Você pergunta aos contatos a cor favorita deles no Rvi
Resposta de Voz Interativa. Menu de telefone automatizado que os contatos usam por meio de entradas de voz ou de teclas para obter informações, rotear uma chamada de voz de entrada, ou ambos.. Você empacota e passa essa seleção como um evento personalizado chamado FavoriteColor. Você também tem um serviço complementar em execução com o seu aplicativo do agente que aguarda o evento FavoriteColor. Isso permite que você passe a seleção de cores do contato para o serviço complementar. O serviço então exibe a cor dentro do aplicativo do agente.
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
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. |