GetMessages

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

Retrieves an inbound digitalClosed 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

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

Digital

Input Properties

These properties define data that the action uses when executing.

Property

Description
Caption

Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon. The default is the action name.

ContactID

The variable that holds the contact ID. 
SubjectVar

The name of the variable that holds the subject of the message.

FromVar The name of the variable that contains the sender of the message The default is FromVar.
ToVar The name of the variable that contains the To address of the message. The default is ToVar.

CCVar

The name of the variable that contains the list of CC list of recipients on the message. The default is CCVar.
DateVar The name of the variable that contains the date of the message. The default is DateVar.
BodyTextVar The name of the variable that contains the body text of the message. The default is BodyTextVar.
AttachmentListVar The name of the variable that contains the list of file attachments. The default is AttachmentListVar.
MaxBodyTextLength The maximum size the message body can have. You can choose from 2K, 4K, 8K, 16K, or 32K. The default is 32K.

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).

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
AttachmentListVar (out)

Holds the list of attachments to the current message. The default variable name is AttachmentListVar.
BodyTextVar (out)

Holds the body text of the current message. The default variable name is BodyTextVar.
CCVar (out)

Holds the customer card. The default variable is CCVar.

DateVar (out)

Holds the date of the current message. The default variable is DateVar.
FromVar(out)

Holds the sender of the current message. The default variable is FromVar.
SubjectVar (out)

Holds the subject line of the current message. The default variable is SubjectVar.

ToVar (out)

Holds the recipient of the current message. The default variable is ToVar.