Architect built-in variables


Built-in variables provide information about things the system tracks automatically, such as the caller’s phone number, or the contact list associated with an outbound flow. This article lists the default system variables built into Architect for each type of flow. You can also access descriptions in the embedded Function and Operator help.

Architect contains various system-scoped variables that begin with Min or Max. These variables hold the minimum and maximum value allowed for certain data types and are similar to constants in many programming languages. In Architect, they are built-in and read-only system variables. For example, the System.Min.DateTime variable holds the minimum allowed value of a DateTime data type, which is January 1st, 1800 at 12:00:00 a.m.

Name Type Collection? Read Only? Description
Call.Ani String No Yes The caller’s origination phone number for the active call (Automatic Number Identification).
Call.CalledAddress String No Yes The called address that caused the caller to enter this flow. For a new inbound call, this value is the same as Call.CalledAddressOriginal, but changes for a flow entered by a transfer, for example.*
Call.CalledAddressOriginal String No Yes The called address received when the call first entered the system; typically the phone number dialed by the caller to reach the system. For a specified call, this value never changes.*
Call.ConversationID String No Yes

The conversation identifier for the active call.

Call.Language String No Yes

The IETF language tag lowercase string value set on the current interaction. 

Note: Within call flows, construct comparisons with IETF language tag string values in a case-insensitive manner.

Call.RemoteName String No Yes Remote name for the active call.

Call.UUIData

String No Yes

Reflects the user-to-user call information (UUI) set on the call.

Note: When you transfer a call from flow to flow, or when the flow disconnects, the variable value does not automatically follow to the next flow.

FindUserByID Collection No Yes Looks up a PureCloud user in the organization by ID number.
FindSystemPrompt String No Yes Searches for an Architect system prompt in the organization.
FindUserPrompt String No Yes Searches for an Architect user prompt in the organization.
FindUsersById String No Yes Looks up multiple PureCloud users in the organization by ID numbers.
Flow.IsDebug Boolean No Yes Indicates if this flow runs in debug mode.
Flow.IsTest Boolean No Yes Indicates whether the flow is running in debug mode.
Flow.StartDateTimeUTC DateTime No Yes The UTC datetime when the flow started execution.
Flow.Version String No Yes The version of the active flow.
Interaction.ID String No Yes The IVR participant's communication ID (or Edge session ID).
System.MaxInt Integer No Yes Holds the maximum value allowed for an Integer, which is 999999999999999.
System.MaxDateTime DateTime No Yes Holds the maximum value allowed for a Date Time, which is December 31, 2200 at 11:59:59 p.m.
System.MaxDuration Duration No Yes Holds the maximum value allowed for a Duration, which is 999999999999999 milliseconds (11574074 days, 1 hour, 46 minutes, and 39.999 seconds).
System.MinInt Integer No Yes Holds the minimum value allowed for an Integer, which is -999999999999999.
System.MinDateTime DateTime No Yes Holds the minimum value allowed for a Date Time, which is January 1, 1800 at 12:00:00AM.
System.MinDuration Duration No Yes Holds the minimum value allowed for a Duration, which is -999999999999999 milliseconds (-11574074 days, -1 hour, -46 minutes, and -39.999 seconds).
System.Regions Enum No Yes Properties that have information made available as subproperties, such as dialing code and country code.
System.Currencies Enum No Yes
A list of available currencies in Architect and information about the currencies made available as subproperties, such as ISO 4217 currency code.
System.Languages Enum No Yes

A list of IETF language tags in Architect.

Note: Like Interaction.Language, when accessing the tag property in flows to obtain the IETF language tag string value, construct comparisons to that value in a case-insensitive manner.

*Note: Various actions cause a call to enter a flow, including, but not limited to:
  • An inbound call arrives.
  • A call transfers to a flow by another flow.
  • A call transfers to a flow by a user. 

Each flow makes available to the flow author two "called address" variables. Consumers typically see these addresses as phone numbers, but they can contain other identifies like a SIP address used for voice conversations over the Internet.

Name Type Collection? Read Only? Description
Call.Campaign Campaign No Yes The campaign for this flow.      
Call.Campaign.id Campaign No Yes The campaign identifier.
Call.ContactList ContactList No Yes The contact list for this flow.
Call.ContactList.id ContactList No Yes The contact list identifier
Flow.WrapupCode WrapupCode No Yes The flow wrapup Code.
Call.Contact Contact No Yes The contact that connects to the flow.
Call.ContactId Contact No Yes The ID of the contact that connects to this flow.

Call.UUIData

String No Yes

Reflects the user-to-user call information (UUI) set on the call.

Note: When you transfer a call from flow to flow, or when the flow disconnects, the variable value does not automatically follow to the next flow.

Name Type Collection? Read Only? Description
Flow.HoldPrompt Prompt No Yes The default hold prompt audio file for the flow.
Call.CurrentQueue Queue No Yes The current queue associated with the call.
Call.EstimatedWaitTime Duration No Yes The current queue's estimated wait time for the call.
Call.PositionInQueue Integer No Yes The call's current position in the queue.

Call.UUIData

String No Yes

Reflects the user-to-user call information (UUI) set on the call.

Note: When you transfer a call from flow to flow, or when the flow disconnects, the variable value does not automatically follow to the next flow.

 

Name Type Collection? Read Only? Description
Email.ConversationID String No Yes The identifier of the active email interaction.
Email.Language String No Yes The IETF language tag lowercase string value set on the current interaction. 
Email.LanguageSkill String No Yes The language skill associated with the active email.
Email.Message Email No Yes The content of the email body.
Email.Message.autoGenerate Email No Yes Whether the email was auto-generated; for example, an out-of-office reply. 
Email.Message.attachments Collection Yes Yes The collection of email attachments on this email.
Email.Message.bcc Collection Yes Yes The collection of email addresses specified in the email's bcc (blind carbon copy) list.
Email.Message.body String No Yes The email body as plain text.
Email.Message.cc Collection Yes Yes The collection of email addresses specified in the email's cc (carbon copy) list.
Email.Message.dateTimeUtc DateTime No Yes The Coordinated Universal Time (UTC) datetime for the email.
Email.Message.from String No Yes

The email "from" address.

Retrieve the email address from it by using .id. Retrieve the name from it by using .name.

Email.Message.htmlBody String No Yes The email body as HTML.
Email.Message.id String No Yes A unique identifier for the email.
Email.Message.replyTo String No Yes The raw address to which to route replies to this email.
Email.Message.subject String No Yes The email subject.
Email.Message.to Collection Yes Yes The collection of email addresses specified in the email's "to" list.
Flow.IsTest Boolean No Yes Indicates whether the flow runs in debug mode.
Flow.StartDateTimeUTC DateTime No Yes The UTC datetime when the flow started execution.
Flow.Version String No Yes The version of the active flow.
System.MaxInt Integer No Yes Holds the maximum value allowed for an Integer, which is 999999999999999.
System.MaxDateTime DateTime No Yes Holds the maximum value allowed for a Date Time, which is December 31, 2200 at 11:59:59 p.m.
System.MaxDuration Duration No Yes Holds the maximum value allowed for a Duration, which is 999999999999999 milliseconds (11574074 days, 1 hour, 46 minutes, and 39.999 seconds).
System.MinInt Integer No Yes Holds the minimum value allowed for an Integer, which is -999999999999999.
System.MinDateTime DateTime No Yes Holds the minimum value allowed for a Date Time, which is January 1, 1800 at 12:00:00AM.
System.MinDuration Duration No Yes Holds the minimum value allowed for a Duration, which is -999999999999999 milliseconds (-11574074 days, -1 hour, -46 minutes, and -39.999 seconds).
Find.User String No Yes Searches for a PureCloud user in the organization.
FindUserByID Collection No Yes Looks up a PureCloud user in the organization by ID number.
FindSystemPrompt String No Yes Searches for an Architect system prompt in the organization.
FindUserPrompt String No Yes Searches for an Architect user prompt in the organization.
FindUsersById String No Yes Looks up multiple PureCloud users in the organization by ID numbers.

Name Type Collection? Read Only? Description
Flow.InvocationData String No Yes The invocation data supplied when the flow starts.

Name Type Collection? Read Only? Description
Message.Campaign Campaign No Yes The campaign for this flow.
Message.ContactID Contact No Yes The ID of the contact that connects to this flow.
Message.ContactList ContactList No Yes The contact list for this flow.
Message.ConversationID String No Yes The conversation identifier for the active message.
Message.IsNewConversation Boolean No Yes Indicates whether the message is in a new conversation.
Message.Language String No Yes The IETF language tag lowercase string value set on the current interaction.
Message.Message ShortMessage No Yes The message associated with the inbound message flow. You can access properties from this variable to get information about the message.
Message.Message.attachments Collection Yes Yes The collection of attachments on this message.
Message.Message.Body String No Yes The body content of the message.
Message.Message.bodyType String No Yes The message body type. For example, text, HTML, or RTF.
Message.Message.dateTimeUtc DateTime No Yes The UTC datetime for the message.
Message.Message.id String No Yes A unique identifier for the message.
Message.Message.senderAddress String No Yes The address of the message sender.
Message.Message.targetAddresses Collection Yes Yes The collection of addresses for the message targets.
Message.Message.type String No Yes The message type. For example, SMS, Facebook, Twitter, and Line.
Flow.IsTest Boolean No Yes Indicates whether the flow runs in debug mode.
Flow.StartDateTimeUTC DateTime No Yes The UTC datetime when the flow started execution.
Flow.Version String No Yes The version of the active flow.
Find.User String No Yes Searches for a PureCloud user in the organization.
FindUserByID Collection No Yes Looks up a PureCloud user in the organization by ID number.
FindSystemPrompt String No Yes Searches for an Architect system prompt in the organization.
FindUserPrompt String No Yes Searches for an Architect user prompt in the organization.
FindUsersById String No Yes Looks up multiple PureCloud users in the organization by ID numbers.

 

Name Type Collection? Read Only? Description
Survey.ConversationEndDateTimeUtc DateTime No Yes The ending DateTime for the conversation associated with this survey invite.
Survey.ConversationID String No Yes The identifier of the completed conversation associated with this survey invite.
Survey.ConversationStartDateTimeUtc DateTime No Yes The starting DateTime for the conversation associated with this survey invite.
Survey.ConversationType String No Yes The conversation type associated with this survey invite. Valid values are call, callback, chat, co-browse, email, screeenShare, socialExpression, or videoComm. Use unknown for anything other than the previous conversation types.
Survey.CustomerAddress String No Yes The address for the customer associated with this survey invite.
Survey.CustomerContact String No Yes The external contact for the customer associated with this survey invite. If no customer contact exists, the value is NOT_SET.
Survey.CustomerContact.address String No Yes The address of the customer contact associated with this survey invite.
Survey.CustomerContact.address.address String No Yes The first address line of the customer contact associated with this survey invite.
Survey.CustomerContact.address.address2 String No Yes The first address line of the customer contact associated with this survey invite.
Survey.CustomerContact.address.city String No Yes The city field of the customer contact address.
Survey.CustomerContact.address.countryCode String No Yes The country code field of the customer contact address.
Survey.CustomerContact.address.postalCode String No Yes The postal code field of the customer contact address.
Survey.CustomerContact.address.state String No Yes The state field of the customer contact address.
Survey.Url String No Yes The URL that links to the survey.
Flow.IsTest Boolean No Yes Indicates whether the flow is running in debug mode.
Flow.StartDateTimeUTC DateTime No Yes The UTC datetime when the flow started execution.
Flow.Version String No Yes The version of the active flow.
Find.User String No Yes Searches for a PureCloud user in the organization.
FindUserByID Collection No Yes Looks up a PureCloud user in the organization by ID number.
FindSystemPrompt String No Yes Searches for an Architect system prompt in the organization.
FindUserPrompt String No Yes Searches for an Architect user prompt in the organization.
FindUsersById String No Yes Looks up multiple PureCloud users in the organization by ID numbers.

 

Feature coming soon

Name Type Collection? Read Only? Description
Chat.ConversationID String No Yes The identifier of the completed conversation associated with this chat message.
Chat.Guest String No Yes The guest associated with the chat message.
Chat.Language String No Yes

The IETF language tag lowercase string value set on the current interaction. 

Find.User String No Yes Searches for a PureCloud user in the organization.
FindUserByID Collection No Yes Looks up a PureCloud user in the organization by ID number.
FindSystemPrompt String No Yes Searches for an Architect system prompt in the organization.
FindUserPrompt String No Yes Searches for an Architect user prompt in the organization.
FindUsersById String No Yes Looks up multiple PureCloud users in the organization by ID numbers.