GETRICHMESSAGE

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

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

Pasa el mensaje enriquecido JSON a la acción AskCaller action o a la acción TExtMsg action digital. Esto le permite utilizar plantillas de mensajes enriquecidos creadas en la página Punto de Contacto Digital en ACD en sus scripts en lugar de crear el JSON en el script.

Dependencias

  • This action requires Digital Experience (DX).
  • Before working with digital scripts, learn about the differences between traditional ACD scripts and digital scripts.
  • Debe usarse con una de las siguientes acciones: AskCaller o TExtMsg.
  • Colocar GETRICHMESSAGE antes AskCaller o TExtMsg en su script.
  • El soporte para el tipo de contenido con mensajes enriquecidos varía por canal, según se muestra en el siguiente menú desplegable.

  • Cree plantillas de mensajes enriquecidos para usar esta acción en la página de Punto de Contacto Digital en NiCE CXone. Puede crear plantillas para selectores de listas, selectores de tiempo, enlaces enriquecidos y respuestas rápidas. Si requiere utilizar otros medios enriquecidos, no puede utilizar GETRICHMESSAGE. En su lugar, debe construir el JSON en una acción Snippet y pasarlo directamente a AskCaller o TExtMsg. Consulte la sección Dependencias en la ayuda en línea para dichas acciones para más información.

Tipos de scripts compatibles

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

Digital

Comparación de acciones similares

Las siguientes acciones tienen funciones similares, pero con algunas diferencias clave:

Propiedades de entrada

Estas propiedades definen los datos que utiliza la acción al ejecutarse.

Las propiedad

Descripción

Caption

Ingrese una frase corta que identifique de forma única esta acción en el script. La leyenda aparece en el lienzo del script debajo del ícono de acción. The default is the action name.

channelID

Seleccione el canal digital que use este script para enviar mensajes.

Propiedades de salida

Estas propiedades contienen variables que incluyen datos que se evuelven al ejecutar la acción. Están disponibles como referencia y para usarse cuando se completa la acción.

Las propiedad

Descripción

resultSet Preserva el JSON que devuelve NiCE CXone. Pasar el contenido de esta variable a Askcaller o TExtmsg como una cadena JSON.

Condiciones de la rama de resultados

Las condiciones de las ramas de resultados le permiten crear ramas en su script para manejar diferentes resultados cuando se ejecute una acción.

Condición

Descripción

Default

Recorrido a menos que el script cumple una condición que requiere uno de los otros poderes. También se considera si no están definidas las demás ramas de la acción.

OnError

Ruta tomada cuando la acción no se ejecuta correctamente. Por ejemplo, cuando haya un problema inesperado como una mala conectividad, errores de sintaxis, etc. La variable _ERR, con un único carácter de subrayado, debe llenarse con una explicación condensada del problema.

OnSucess.

Ruta que se toma si la acción finaliza sin errores y cualquier llamada API o devolución de datos se realiza correctamente (códigos de respuesta 2xx).

Se requiere de código de acción para el SNIPPET

Esta acción puede requerir una Snippet acción con código que manipula las plantillas de medios enriquecidos que devuelve la GETRICHMESSAGE acción a partir del punto de contacto digital. Si el punto de contacto únicamente tiene una plantilla, no requiere código para el snippet. Puede utilizar la variable que se especifica en la propiedad resultId . En el caso de los puntos de contacto que tienen más de una plantilla, necesita de código para el snippet.

  1. Create a template on the Points of Contact Digital page in the ACD application and assign it to the point of contactClosed punto de entrada que utiliza un contacto entrante para iniciar una interacción, como un número de teléfono o una dirección de correo electrónico. you want to use it with. You may need assistance from a NiCE CXone administrator to complete this step.

  2. Create a script with the digital media type.

  3. Add a GETRICHMESSAGE action and either an ASKCALLER action or a TeXTMSG action. If the point of contact has more than one template, you also need a SNIPPET action.
  4. Configure the ChannelId property in GETRICHMESSAGE with the point of contact you assigned the template to.
  5. Add the appropriate code to the SNIPPET action:
    • If you only have one template or if you only want to send one template with this script, use code such as:

      DYNAMIC json1 
      ASSIGN json1.data[1] = resultset.data[1]
    • If you have multiple templates and want to be able to send more than one with this script, use code such as:

      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. Change the index number that identifies the template you want to send. In the example code from the previous step, you would change the index numbers in the resultset.data[x] variable. Do not change the index in the variable you're assigning the template to. In the example code, the variable is jsonY.data[Z], and you could change Y but not Z. Each jsonY variable holds one template.
  7. Modify the variable names if you want. If you do, change the variable names as needed in the other actions in the script. For example, resultSet is the default variable name in the resultSet property of GETRICHMESSAGe. The jsonY variables are used in the Message property of AskCaller and Textmsg.
  8. Configure AskCaller or Textmsg: 
    1. Set the MessageFormat property to JSON.
    2. Configure Message with the name of the variable that holds the JSON of the template you're sending. It must be sent as a JSON string. You can use variable substitution in this field. If you do, add code to a Snippet to choose the template to send and pass the right variable on.
    3. Configure other properties of the actions as needed, including connecting the branches. Refer to the online help for the ASKCALLER action or TeXTMSG action.

Ejemplo de secuencia de comandos

Este es un ejemplo para demostrar cómo se puede utilizar esta acción en los scripts. No pretende ser un script completo. Es posible que se requiera programación adicional.

Este ejemplo muestra la acción GETRICHMESSAGE conectada a una acción SNIPPET, que se conecta a TeXTMSG. También podría estar conectada a ASKCALLER. Cuando se ejecuta el script, GETRICHMESSAGE obtiene las plantillas de mensajes enriquecidos disponibles para el canal digtal especificado en channelId. Se almacenan en la variable especificada en la propiedad resultId. En este ejemplo, la variable es resultId. El código de snippet contiene un objeto dinámico de datos que almacenará una plantilla de mensaje enriquecido JSON y la transfiere a TeXTMSG.

Un script de muestra que contiene las acciones BEGIN, GETRICHMESSAGE, SNIPPET y TEXTMSG.

Descargue este script.