CustomEvent

Cette page d'aide concerne Desktop Studio. Ces informations sont également disponibles pour Studio.

Types de scripts pris en charge

The icon for a Generic script type - a rectangle with < and > symbols inside it.

L'icône du type de script E-mail - un grand symbole @ dans un losange.

L'icône du type de script Chat - une bulle de chat avec des points de suspension à l'intérieur (...), en forme de losange.

L'icône du type de script Téléphone - un combiné téléphonique à l'ancienne avec des lignes courbes indiquant que le son en sort.

L'icône du type de script de messagerie vocale - un symbole qui ressemble à une cassette - deux cercles assis sur une ligne horizontale.

L'icône pour le type de script d'élément de travail - un morceau de papier avec un coin replié et une liste à puces dessus.

" L'icône du type de script SMS - un téléphone intelligent avec une bulle de discussion qui en sort."

Générique

Email Conversation Téléphone Messagerie vocale Élément de travail SMS

Propriétés de saisie

Ces propriétés définissent les données que l'action utilise lors de son exécution.

Propriété

Description

Légende

Entrez une courte phrase qui identifie cette action dans le script de manière unique. La légende est affichée sur le canevas de script sous l’icône de l’action. La valeur par défaut est le nom de l’action.

TargetAgent

L'ID de l'agent visé par l'événement personnalisé. Le script Studio alimente la variable AgentId après l'événement OnAnswer pour un appel entrant. L'événement personnalisé s'exécute uniquement lorsque l'AgentId est renseigné. Si vous souhaitez envoyer un événement personnalisé avant l’affectation de l’agent, vous devez fournir un id de l’agent dans le champ TargetAgent.

EventName

Entrez le nom de l'événement personnalisé. Plusieurs événements portant le même nom se remplaceront. Seul le nom de l’événement le plus récent est conservé. Ce champ est sensible à la casse.

PersistInMemory

Si un événement est exécuté alors qu'un agent est déconnecté et que vous souhaitez qu'il reçoive l'événement lorsqu'il se reconnecte, définissez cette valeur sur true. Sinon, définissez-la sur false.

Données

Charge utile de données pour cet événement.

Conditions de la branche résultat

Les conditions de branche de résultat vous permettent de créer des branches dans votre script afin de gérer différents résultats lors de l'exécution d'une action.

Condition

Description

Par défaut 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 Chemin emprunté si l'agent de destination est non connecté.

Exemple de script

Cet exemple montre comment cette action peut être utilisée dans les scripts. Il ne s'agit pas d'un script complet. Des scripts supplémentaires peuvent être nécessaires.

Script example

Dans cet exemple de script, les branches illustrent trois scénarios dans lesquels vous générez un événement personnalisé :

  • Branche 1 : initiation et réception d'un événement personnalisé avant toute interaction avec un agent. L'événement personnalisé est reçu par la boucle get-custom-event lorsqu'un contact appuie sur 1.

  • Branche 2 : initiation et réception d'un événement personnalisé avant toute interaction avec un agent. L'événement personnalisé est reçu par la boucle get-custom-event lorsqu'un contact appuie sur 2. Par ailleurs, un autre événement personnalisé est généré après le déclenchement de Reqagent et avant que l'agent ne réponde à l'appel.

  • Branches 2 & 3 : Lancement et réception d'un événement personnalisé après qu'un Agent a répondu à l'appel.

Créer des Événements personnalisés via l'API

Vous pouvez également créer un événement personnalisé à l'aide de l'API custom-event Icône d'un carré gris foncé avec une flèche sortant de son coin supérieur droit. Cela peut s'avérer nécessaire si l'action CustomEvent ne répond pas aux exigences de votre cas d'utilisation. Comme les services consomment généralement déjà le flux d'événements de l'agent, il peut s'agir d'une méthode pratique pour partager des données sans avoir à mettre en œuvre votre propre point de terminaison personnalisé. Ceci est particulièrement pertinent pour les applications ou microservices à petite portée.

L'utilisation de l'API est similaire à l'action Studio, sauf que vous utilisez des paramètres au lieu de propriétés. L'utilisation des API NiCE CXone exige également que vous mettiez en œuvre l'authentification de l'API. Lorsque vous utilisez l'API, veillez à :

  • Nommer l'événement.

  • Affecter un agent cible dans le paramètre agentId ou la propriété Agent cible de l'action Studio. Vous pouvez utiliser l'id de la variable AgentId. Celle-ci est automatiquement remplie après l'événement OnAnswer. Si vous souhaitez envoyer un événement personnalisé avant qu'un agent ne soit affecté, vous devez tout de même fournir un ID d'agent.
  • Définissez le champ persistInMemory. Si l'agent est déconnecté, cela détermine s'il recevra l'événement après s'être reconnecté.
  • Remplissez le champ Data, qui est la charge utile sous forme de chaîne de caractères.
  • Consommez l'événement personnalisé avec l'API get-next-event Icon of dark gray square with an arrow pointing out of its upper right corner ou l'action Obtenir l’événement suivant Studio.

Vous trouverez ci-dessous un exemple de création d'un événement personnalisé via l'API :

Exemple 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"

Type de demande : PUT

Champs :

Paramètre Type Détails
agentId Chaîne La valeur de l'ID de l'agent qui identifie l'agent cible.
eventName Chaîne Le nom de l'événement. Ce nom doit être utilisé par tous les consommateurs de l'événement.
persistInMemory Booléen Si l'agent identifié par agentId n'est pas actuellement connecté, l'événement sera ignoré ou restera pour l'agent une fois qu'il se sera reconnecté.
data Chaîne N'importe quelle chaîne de données.