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.

Transfiere un JSON de mensaje rico a la acción AskCaller digital o la acción TExtMsg.  Esto le permite usar plantillas de mensajes enriquecidas creadas en la página Digital del Punto de Contacto en ACD en sus scripts en vez de construir el JSON en el script.

Dependencias

  • Esta acción demanda Digital Experience.
  • Antes de trabajar con scripts digitales, aprenda las diferencias entre los scripts ACD tradicionales y los scripts digitales.
  • 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 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. De lo contrario, se debe construir el JSON en una acción Snippet y transferirla 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 secuencias de comandos compatible

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

Leyenda

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 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. Crear una plantilla en la página Digital de Puntos de Contacto en ACD aplicación y asignarla al punto de contacto con que desee usarla. Puede requerir ayuda de un administrador CXone para concluir este paso.

  2. Crear un script con el tipo de medio digital.

  3. Agregar una GETRICHMESSAGE acción y una ASKCALLER acción o una TeXTMSG acción. Si el punto de contacto tiene más de una plantilla, también necesita una SNIPPET acción.
  4. Configure la propiedad ChannelId en GETRICHMESSAGE con el punto de contacto al que asignó la plantilla.
  5. Agregue el código adecuado a la acción SNIPPET:
    • Si usted tiene únicamente una plantilla o si únicamente quiere enviar una plantilla con este script, use código como:

      DYNAMIC json1 
      ASSIGN json1.data[1] = resultset.data[1]
    • Si tiene múltiples plantillas y desea poder enviar más de una con este script, use el código como:

      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. Cambie el número de índice que identifica la plantilla que desee enviar. En el código de ejemplo del paso previo, puede cambiar los números de índice en la variable resultset.data[x]. No cambie el índice en la variable a la que le está asignando la plantilla. En el código de ejemplo, la variable es jsonY.data[Z], y podría cambiar Y pero no Z. Cada variable jsonY almacena una plantilla-
  7. Modifique los nombres de variables si así lo desea. De hacerlo, cambie los nombres de variables según sea necesario en las otras acciones en el script. Por ejemplo, resultSet es el nombre de la variable predeterminada en la propiedad resultSet de GETRICHMESSAGe. Las variables jsonY se usan en la propiedad Mensaje de AskCaller y Textmsg.
  8. Configurar AskCaller o Textmsg
    1. Defina la propiedad MessageFormat a JSON.
    2. Configurar Message con el nombre de la variable que almacena el JSON de la plantilla que está enviando. Debe enviarse como una cadena JSON. Puede utilizar la sustitución de variables en este campo. De hacerlo, agregue código a un Snippet para elegir la plantilla en la que enviar y transferir la variable correcta.
    3. Configure otras propiedades de las acciones según se necesite, incluyendo conectar las bifurcaciones. Consulte la ayuda en línea para la acción ASKCALLER o la acción TeXTMSG.

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. Quizá se requieran scripts adicionales.

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.

Descarga este script.