System variables are prefixed with the @ symbol.
|
Variable |
Description |
|
@Service Name |
The name of the script. |
|
@New Line |
This adds a new line. Use this in the Format String action cell. |
|
@Carriage Return |
This moves the cursor to the beginning of the current line. Use this in the Format String action cell. |
Available in a Dial script for an OUTBOUND campaign.
|
Variable |
Description |
|
@ID |
The unique ID for the call. |
|
@Name |
The name of the contact. |
|
@Number |
The Dialled number. |
|
|
The contact’s email address. |
|
@Misc1 - @Misc20 |
Miscellaneous fields 1 - 20, mainly for user-defined data. |
|
@Attempts |
The number of attempts made to call this number. |
|
@Last Result |
The result of the last processing attempt. Either a system-generated value (for example 'Busy' or 'Preview rejected by agent), or the last agent-selected completion code. |
|
@Last Called |
The date and time at which the contact was last processed by OUTBOUND. |
|
@Table Name |
The DATA MANAGEMENT table name. |
|
@View Name |
The DATA MANAGEMENT table view name |
|
@System Retry |
This indicates whether or not the call was placed as a result of the record being selected using the retry profile assigned to the campaign. |
|
@Scheduled Callback |
This indicates whether or not the call was made as an agent-scheduled callback. |
|
@Callback Time |
For a call pertaining to an agent-scheduled callback, the date and time the callback was scheduled to be placed. |
|
@Callback Agent |
For a call pertaining to an agent-owned callback, the name of that agent. |
|
Variable |
Description |
|
The originating number. |
|
|
@DDI |
The dialled number. |
Note: on the UK, US, and Japanese storm platforms, these numbers are presented in local format (for example, 07700900873 in the UK). On other platforms, such as EU, they are presented in the international E.164 format (for example, +32 4561413415).
Available for inbound SMS messages only.
|
Variable |
Description |
|
@SMS Origination |
The originating number. |
|
@SMS Destination |
The destination number. |
|
@SMS Message |
The message text. |
|
@SMS Keyword |
The SMS keyword. |
|
Variable |
Description |
|
@From Address |
The 'From' address. |
|
@To Address |
The 'To' address. |
|
@CC Address |
The 'CC' address. |
|
@Email Subject |
The email subject. |
|
@Email Message |
The message text. |
|
@Matched Email Address |
Where the email has more than one ‘To’ email address, this is the one to which it was routed by the script. |
|
@Number of Email Attachments |
The number of attachments in the email. |
|
Variable |
Description |
|
@Web Origination |
The originating number. |
|
@Web Destination |
The destination number. |
|
@Message Header |
The message header. |
|
@Message Content |
The message content. |
These are for Web Chat 1.0 only. For Web Chat 2.0 and 3.0, use the chat variables in the Messaging Engine category.
|
Variable |
Description |
|
@IM Mailbox |
The name given to the web chat URL's access point. |
|
@IM Chat ID |
The unique ID generated for the web chat conversation. |
|
@IM Name |
The guest name, as entered by them. |
|
@IM Subject |
The chat subject, as entered by the guest. |
|
@IM Query Parameters |
If your organisation implements a custom form to enable customers to start a web chat, the information on the form is passed to the script via this parameter. (See the description of the Parse String action cell.) |
|
The ID of the last agent to have serviced the web chat. It is populated only if the session was restarted by the guest following a timeout due to inactivity. The ID allows the guest to be routed to the same agent via the Route to Contact action cell's Preferred Agent Identifier property. |
|
Variable |
Description |
|
|
@CallRecord |
This is a structured variable that is made up of several elements. It is populated by an incoming call. However, if you create a new instance of the variable and use it in the Outbound Call action cell, then that instance will only be populated with data relating to the outbound call. |
|
|
|
DDI |
The Dialled number. |
|
|
CLI |
The originating number. |
|
|
CLIWithheld |
True: CLI withheld. False: CLI not withheld. |
|
|
PresentationCLI |
The presentation CLI for the call. |
|
|
PresentationCLIWithheld |
True: The presentation CLI was withheld. False: The presentation CLI was NOT withheld. |
|
|
CallID |
The unique ID for the call. |
|
|
StartTime |
The time at which the call reached the storm platform in the format YYYY-MM-DD HH:MM:SS. |
|
|
SetupDuration |
The duration between the call reaching the storm platform and being routed to its destination (rounded to the nearest tenth of a second). |
|
|
RingingDuration |
The call ringing duration (rounded to the nearest tenth of a second). |
|
|
CallDuration |
The call duration (rounded to the nearest tenth of a second). This includes calls that are in progress. |
|
|
ClearingCause |
The call result code, using Q.850 values. For incoming calls, this variable is populated when the call ends (its value is available in a clear down handler script). For calls made via the Outbound Call action cell, the value can be captured in a user variable. |
|
|
Transferor User ID |
The ID of the storm UC and CONTACT user who transferred the call to the script. |
|
|
Transferor Username |
The username of the storm UC and CONTACT user who transferred the call to the script. |
Although still supported, these are superseded by the Messaging Engine system variables, which you should use in new scripts.
|
Variable |
Description |
|
@Facebook Origination |
The originating Facebook account. |
|
@Facebook Destination |
The destination Facebook account. |
|
@Facebook Message |
The message content. |
|
@Facebook DM Flag |
This indicates whether the message was posted on the Facebook page (a public message) or whether it was received from that page via Facebook Messenger (a direct message). |
|
@Facebook Message Status |
This indicates whether the message is an initial public post, an initial direct message, or a follow-on comment. |
|
@Facebook Metadata |
Any additional information provided by Facebook. |
These are for all social media channels. They supersede the IM and Facebook system variables and should be used instead of those.
|
Variable |
Description |
|
|
For Web Chat 2.0 and 3.0 This is a structured variable that is made up of several elements. It is populated by an incoming web chat request. |
||
|
|
Name |
The guest name, as entered by them. |
|
|
Subject |
The chat subject, as entered by the guest. |
|
|
AdditionalData |
If using the storm Web Chat API, this information is passed in to this parameter when a new chat session begins. Also, if your organisation implements a custom form to enable customers to start a web chat, the information on the form is passed to the script via this parameter. (See the description of the Parse String action cell.) |
|
Language |
The language of the incoming web chat, allowing the chat to be routed to the agent who speaks that language. |
|
|
@Chat Destination |
For Web Chat 2.0 and 3.0 The name given to the social media access point. |
|
|
@Chat Message |
For Web Chat 2.0 and 3.0 The content of the first message in the interaction (up to 256 characters). |
|
|
@Chat Origination |
For Web Chat 2.0 and 3.0 The name of the social media user. |
|
|
@Trustpilot |
This is a structured variable that is made up of the following six elements. |
|
|
|
Language |
The language of the review submitted by the consumer (for example, English). |
|
|
StarRating |
The star rating submitted by the consumer. |
|
|
ReviewId |
The ID of the review submitted by the consumer. |
|
|
BusinessUnitId |
The business Unit ID (a unique key for the domain). |
|
|
ConsumerId |
The ID of the consumer who submitted the review. |
|
|
Title |
The title of the review message (for example, 'Excellent service!'). |
|
|
This is a structured variable that is made up of the following 'CustomerNumber' element. |
|
|
CustomerNumber |
The origination telephone number of the sender. |
|