GetMessages

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

A chat bubble with an arrow inside it pointing down.

Retrieves an inbound digital Any channel, contact, or skill associated with Digital Experience. message and stores it as a structured variable. You can reference the structured variable anywhere regular variables can be referenced.

GetMessages allows you to name the variables that contain the pieces of the retrieved message. For example, if you name the BodyTextVar variable "body", you can use the {body} variable anywhere curly braces are supported. This is especially useful in generating automatic responses.

This action is the digital equivalent of the Getemail action.

Dependencies

This action requires Digital Experience.
Before working with digital scripts, learn about the differences between traditional ACD scripts and digital scripts.
Using a pipe delimiter ( | ) in an message subject line causes the subject to be split into an array. If this happens, the subject line must be pieced back together.

Supported Script Types

Digital

Input Properties

These properties define data that the action uses when executing.

Property	Description
Add Caption	Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon.
Contact Id	The variable that holds the contact ID.
From Variable	The name of the variable that contains the sender of the message The default is FromVar.
To Variable	The name of the variable that contains the To address of the message. The default is ToVar.
CC Variable	The name of the variable that contains the list of CC list of recipients on the message. The default is CCVar.
Date Variable	The name of the variable that contains the date of the message. The default is DateVar.
Body Text Variable	The name of the variable that contains the body text of the message. The default is BodyTextVar.
Attachment List Variable	The name of the variable that contains the list of file attachments. The default is AttachmentListVar.
Maximum Body Text Length	The maximum size the message body can have. You can choose from Limit 2K, Limit 4K, Limit 8K, Limit 16K, or Limit 32K. The default is Limit 32K.

Output Variables

These properties contain variables that hold data returned from executing the action. They're available for reference and use when the action completes.

Property	Description
Attachment List Variable	Holds the list of attachments to the current message. The default variable name is AttachmentListVar.
Body Text Var	Holds the body text of the current message. The default variable name is BodyTextVar.
CC Variable	Holds the customer card. The default variable is CCVar.
Date Variable	Holds the date of the current message. The default variable is DateVar.
From Variable	Holds the sender of the current message. The default variable is FromVar.
Subject Variable	Holds the subject line of the current message. The default variable is SubjectVar.
To Variable	Holds the recipient of the current message. The default variable is ToVar.

Result Branch Conditions

Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.

Condition	Description
Default	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.
OnError	The path taken when the action doesn't execute properly. For example, when there's an unexpected problem, such as poor connectivity, syntax errors, HTTP error codes, and so on. The ERR variable should be populated with a condensed explanation of the problem.
OnSuccess	Path taken if the action completes without errors and any API calls or data returns were successful (2xx response codes).