GETRICHMESSAGE

This help page is for Desktop Studio. This information is also available for CXone Studio.

Three shapes containing iconograhic representations of lists, imgs, and music files.

Transmet le JSON du message enrichi à l’action AskCaller  numérique ou à l’action TExtMsg.  Cela vous permet d’utiliser les modèles de messages enrichis créés sur la page Point d’accès numérique dans ACD dans vos scripts au lieu de construire le JSON dans le script.

Dépendances

  • Cette action nécessite Digital Experience.
  • Avant de travailler avec des scripts numériques, renseignez-vous sur les différences entre les scripts ACD traditionnels et les scripts numériques.
  • Doit être utilisé avec l’une des actions suivantes : AskCaller ou TExtMsg.
  • Placez GETRICHMESSAGE avant AskCaller ou TExtMsg dans votre script.
  • La prise en charge du type de contenu de messagerie enrichie varie selon le canal, comme le montre la liste déroulante suivante.

  • Créez des modèles de messages enrichis à utiliser avec cette action sur la page Point d’accès numérique dans CXone. Vous pouvez créer des modèles pour les sélecteurs de liste, les sélecteurs de temps, les liens enrichis et les réponses rapides. Si vous devez utiliser d’autres médias enrichis, vous ne pouvez pas utiliser GETRICHMESSAGE. Au lieu de cela, vous devez construire le JSON dans une action Snippet et le transmettre directement à AskCaller ou TExtMsg. Pour plus d’informations, consultez la section Dépendances dans l’aide en ligne de ces actions.

Types de scripts pris en charge

The icon for the Digital script type - a computer monitor with a smartphone next to it.

Numérique

Comparaison d’actions similaires

Les actions suivantes ont des fonctions semblables, mais avec quelques différences essentielles :

Propriétés d’entrée

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

Propriété

Description

Légende

Saisissez une courte phrase qui identifie de manière unique cette action dans le script. La légende apparaît dans le canevas de script sous l’icône d’action. The default is the action name.

channelID

Sélectionnez le canal numérique utilisé par ce script pour envoyer des messages.

Propriétés de sortie

Ces propriétés contiennent des variables qui contiennent les données renvoyées par l’exécution de l’action. Elles sont disponibles pour référence et utilisation lorsque l’action est terminée.

Propriété

Description

resultSet Contient le JSON renvoyé par CXone. Transmettez le contenu de cette variable à Askcaller ou TExtmsg sous la forme d’une chaîne JSON.

Conditions de la branche de 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

Default

Chemin emprunté à moins que le script ne remplisse une condition exigeant qu’il prenne l’une des autres branches. Elle est également prise si les autres branches de l’action ne sont pas définies.

OnError

Chemin emprunté lorsque l’action ne s’exécute pas correctement. Par exemple, en cas de problème inattendu tel qu’une mauvaise connectivité, des erreurs de syntaxe, etc. La variable _ERR, avec un seul caractère de soulignement, doit être remplie avec une explication condensée du problème.

OnSucess

Chemin emprunté si l’action se termine sans erreur et si les appels à l’API ou les retours de données se sont correctement déroulés (codes de réponse 2xx).

Code d’action SNIPPET requis

Cette action peut nécessiter une action Snippet avec un code qui gère les modèles de médias enrichis que l’action GETRICHMESSAGE renvoie du point d’accès numérique. Si le point d’accès n’a qu’un seul modèle, vous n’avez pas besoin d’extrait de code. Vous pouvez utiliser la variable spécifiée dans la propriété resultId. Pour les points d’accès qui ont plus d’un modèle, vous avez besoin d’un extrait de code.

  1. Créez un modèle sur la page Points d’accès numériques dans l’application ACD et attribuez-le au point d’accès avec lequel vous souhaitez l’utiliser. Il se peut que vous ayez besoin de l’aide d’un administrateur CXone pour réaliser cette étape.

  2. Créer un script avec le type de support numérique.

  3. Ajoutez une action GETRICHMESSAGE et soit une action ASKCALLER, soit une action TeXTMSG. Si le point d’accès a plus d’un modèle, vous avez également besoin d’une action SNIPPET.
  4. Configurez la propriété ChannelId dans GETRICHMESSAGE avec le point d’accès auquel vous avez attribué le modèle.
  5. Ajoutez le code approprié à l’action SNIPPET :
    • Si vous n’avez qu’un seul modèle ou si vous ne voulez envoyer qu’un seul modèle avec ce script, utilisez un code tel que :

      DYNAMIC json1 
      ASSIGN json1.data[1] = resultset.data[1]
    • Si vous avez plusieurs modèles et que vous souhaitez pouvoir en envoyer plus d’un avec ce script, utilisez un code tel que :

      DYNAMIC json1
      DYNAMIC json2
      DYNAMIC json3
      				 
      ASSIGN json1.data[1] = resultset.data[1]
      ASSIGN json2.data[1] = resultset.data[2]
      ASSIGN json3.data[1] = resultset.data[3]
  6. Modifiez le numéro d’index qui identifie le modèle que vous souhaitez envoyer. Dans l’exemple de code de l’étape précédente, vous devez modifier les numéros d’index de la variable resultset.data[x]. Ne modifiez pas l’index de la variable à laquelle vous affectez le modèle. Dans le code de l’exemple, la variable est jsonY.data[Z], et vous pouvez modifier Y, mais pas Z. Chaque variable jsonY contient un modèle.
  7. Modifiez les noms des variables si vous le souhaitez. Si c’est le cas, modifiez les noms des variables en fonction des besoins dans les autres actions du script. Par exemple, resultSet est le nom de la variable par défaut dans la propriété resultSet de GETRICHMESSAGe. Les variables jsonY sont utilisées dans la propriété Message de AskCaller et Textmsg.
  8. Configurez AskCaller ou Textmsg : 
    1. Définissez la propriété MessageFormat sur JSON.
    2. Configurez Message avec le nom de la variable qui contient le JSON du modèle que vous envoyez. Il doit être envoyé sous la forme d’une chaîne JSON. Vous pouvez utiliser la substitution de variables dans ce champ. Si vous le faites, ajoutez du code à Snippet pour choisir le modèle à envoyer et transmettre la bonne variable.
    3. Configurez d’autres propriétés pour les actions si nécessaire, y compris la connexion des branches. Consultez l’aide en ligne pour l’action ASKCALLER ou l’action TeXTMSG.

Exemple de script

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

Cet exemple montre l’action GETRICHMESSAGE connectée à une action SNIPPET, elle-même connectée à TeXTMSG. Elle pourrait également être connectée à ASKCALLER. Lorsque le script est exécuté, GETRICHMESSAGE récupère les modèles de messages enrichis disponibles pour le canal numérique spécifié dans channelId. Ils sont stockés dans la variable spécifiée dans la propriété resultId. Dans cet exemple, la variable est resultId. Le code de l’extrait contient un objet de données dynamiques qui contiendra un modèle de message enrichi JSON spécifique et le transmettra à TeXTMSG.

Un exemple de script contenant les actions BEGIN, GETRICHMESSAGE, SNIPPET et TEXTMSG.

Télécharger ce script.