Messages

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

A square with two stacked short horizontal lines and a small empty circle inside it.

Delivers a message to one or more agents who use the agent interface. The message can contain text only. Links and pictures are not supported. Messages is typically used to send a message to a single agent when they answer a contact.

Supported Script Types

A square with a line branching from it that goes to three other squares.

Generic

 Email Chat Phone Voicemail Work Item SMS

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.

Target Type Select the recipient type from the drop-down: Agent, Team, Station, Skill, Everyone.
Target Id The ID of the target, such as an agent ID or a skill ID. This is not used if Target Type is Everyone. This field is required if Target Type is set to any of the other options. To send a message to the agent who answered the call, use the {agentId} variable.
Message Text The text that is sent to the selected target when this action executes. You can use variables in this field.
Duration Min

For MAX, this is the amount of time in minutes you want the message popover to be displayed. If the value is 0 or if this property is empty, the message displays for five seconds, which is the default. After that time, it's available in the agents' message inboxes. To determine how long the message remains in the message inbox, MAX combines the DurationMin and ExpireDateTime. There are four possible combinations: 

  1. DurationMin = null and ExpireDateTime > now

    The message remains in the MAX messages inbox until ExpireDateTime.

  2. DurationMin > 0 and ExpireDateTime > now

    The message remains in the MAX messages inbox until ExpireDateTime + DurationMin.

  3. DurationMin = null and ExpireDateTime = null

    The message appears in the MAX messages box for five seconds.

  4. DurationMin > 0 and ExpireDateTime = null

    The message stays in the MAX messages inbox for DurationMin.

For CXone Agent Suite applications, this is the amount of time in minutes you want the message to remain in the notification panel after the agent logs in. For example, if you enter 3 for DurationMin, the message remains in the notification panel for 3 minutes. In the CXone Agent Suite, all messages automatically display as pop-ups for 5 seconds.

The message displays as a pop-up for 5 seconds.

The message is displayed as a pop-up. A red number 1 icon also displays next to the Notifications icon, indicating the number of messages the agent's received.

Because its DurationMin has been set to 3, it remains in the notification panel for 3 minutes.

When the agent clicks the Notification icon, the message appears.

Persistent Not used.
Expire Datetime Determines a date and time when the message disappears from the messages inbox. For MAX, this value is added to DurationMin to determine how long the message remains in the inbox.

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.

Error

Path taken when the action fails to execute properly. For example, when there is an unexpected problem such as poor connectivity, syntax errors, and so on. The _ERR variable, with a single underscore character, should be populated with a condensed explanation of the problem.

Text Formatting

You can format the message text to emphasize or customize words or phrases. The text formatting is similar to HTML code. To change the color, typeface (font), or size of a section of text, surround the text with a FONT tag and add the attributes to the tag. Each attribute within the font tag must be separated by a single space. Do not enter a space between the attribute name or value - for example, <FONT color=red> is correct, and <FONT color= red> is incorrect. The table below lists all formatting options.

Formatting: 

Beowulf,<b>great</b> hero of the <FONT face=times size=+1> Geats</FONT>, I beg you to display your 
prowess by defending my hall,<FONT face=times>Heorot</FONT>, From the monster <FONT color=red 
size=+2><i>Grendel</i></FONT>!

Output:
Beowulf, great hero of the Geats, I beg you to display your prowess by defending my hall, Heorot, from the monster Grendel!


Additional options when formatting text:

  • Font attributes can be embedded: <FONT face=times>And thus, Beowulf slayed <FONT color=red size=+2>Grendel</FONT> and his monster mother.</FONT> The color and size attributes did not disturb the face attribute.
  • Multiple font attributes may be specified in a single tag: All hail, Beowulf, <FONT size=+2 color=$000080 face=times>king of the Geats</FONT>! The one tag contains size, face, and color attributes.
  • Bold and italic format changes are added outside of the font tag; for example: <FONT color=$FFD700><b>Beowulf</b></FONT> would generate "Beowulf".

The following table displays possible text formatting attributes and the availability within the Agent applications:

Attributes

Description

color={colorvalue}

 The color attribute can contain the following values:
aquablackblue
dkgray
(dark gray)		fuchsiagray
greenlimeltgray (light gray)
maroonnavyolive
purpleredsilver
tealwhiteyellow
{decimal color}
(for example,
color=10990679

${hexcolor}
(for example, color=$31B94D)

 

size=[+/-]{pointsize}

Point size is relative or absolute; -9 is normal. For example, size=+2.

face={fontname}

 The face attribute can contain the following font types:
arialtimes (or times new roman)courier
verdanaimpactgeorgia
garamondsystemtahoma

<b>

Html bold styling.

<i>

Html italic styling.
<br> Creates a line break.