Architect built-in variables

AI-generated summary

Genesys Cloud Architect provides comprehensive system variables that automatically track interaction metadata and flow execution details across multiple communication channels including calls, emails, messages, chats, voicemails, surveys, and bot interactions. These read-only, system-scoped variables enable flow authors to access critical data throughout various workflow configurations. Call-related variables capture essential interaction information such as ANI (caller's origination phone number), CalledAddress and CalledAddressOriginal (dialed numbers and initial routing addresses), ConversationID (unique interaction identifiers), Language (IETF language tags), LastCollectionMode (speech or DTMF input tracking), RemoteName, ExternalContactId, ExternalTag, and UUIData (user-to-user information). Additional call variables include ACDSkills for interaction routing and CurrentQueue for queue association. Flow variables track execution state through IsTest (debug mode indicator), StartDateTimeUTC (execution timestamps), and Version (active flow identification). Outbound flow variables provide access to campaign identification, contact list association, contact information, and wrap-up code tracking, enabling comprehensive campaign management and contact data utilization. Email, message, and survey variables encompass campaign associations, contact identifiers, conversation IDs, external contact information, language settings, and authentication status. Chat variables include conversation IDs, guest associations, IETF language tags, and journey context data for customer identification and session tracking. Voicemail variables support debug functionality with entity type information and custom name audio recording capabilities. Session variables capture interaction context including ActiveIntent, ChannelType, authentication status, language settings, and confidence metrics for automatic speech recognition and natural language understanding. Menu variables return collection states indicating whether input was detected or matched configured choices, with NOT_SET Boolean values when no user input has been solicited. System variables define operational boundaries: maximum integer value of 999999999999999, maximum datetime of December 31, 2200 at 11:59:59 p.m., maximum duration of 999999999999999 milliseconds, and corresponding minimum values. Min and Max variables function as constants similar to programming language constructs, with System.MinDateTime representing January 1st, 1800 at 12:00:00 a.m. Key limitations include Architect's selection of only the first external contact based on start date when multiple contacts exist, outbound voice campaigns returning null ExternalContactId values due to unsupported identity resolution, and UUIData not automatically transferring between flows during call transfers or disconnections. Language tag comparisons are constructed in a case-insensitive manner within call flows. All variables support read-only access with optional collection capabilities where applicable, enabling dynamic flow logic, skill-based routing, and temporal management within Architect workflows.

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.MinDateTime variable holds the minimum allowed value of a DateTime data type, which is January 1st, 1800 at 12:00:00 a.m.

Showentries

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.ExternalContactId	String	No	Yes	A unique identifier for the external contact. Note: Architect does not support multiple external contact IDs. It selects the first contact on the conversation based on startDate.
Call.ExternalTag	String	No	Yes	The external tag 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.LastCollectionMode	String	No	Yes	Holds the collection mode for the customer’s most recent input. The system overwrites the value each time the customer provides a new input. Valid values are the strings “speech”or “dtmf.” If the customer has not provided any input, Architect sets this variable to “NOT_SET.”
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.

Showing results

1 - 10 of 26

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

Showentries

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.ExternalContactId	String	No	Yes	A unique identifier for the external contact. Notes: Architect does not support multiple external contact IDs. It selects the first contact on the conversation based on startDate. Outbound flows return a null value for the Call.ExternalContactId variable because outbound voice campaigns do not support identity resolution currently.
Call.LastCollectionMode	String	No	Yes	Holds the collection mode for the customer’s most recent input. The system overwrites the value each time the customer provides a new input. Valid values are the strings “speech”or “dtmf.” If the customer has not provided any input, Architect sets this variable to “NOT_SET.”
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.

Showing results

1 - 10 of 10

Showentries

Name	Type	Collection?	Read Only?	Description
Flow.HoldPrompt	Prompt	No	Yes	The default hold prompt audio file for the flow.
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.
Call.Ani	String	No	Yes	The caller’s origination phone number for the active call (Automatic Number Identification).
Call.ACDSkills	Skill	Yes	Yes	This variable holds the ACD skills for the interaction.
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.CurrentQueue	Queue	No	Yes	The current queue associated with the call.

Showing results

1 - 10 of 30

Showentries

Name	Type	Collection?	Read Only?	Description
Email.Campaign	Campaign	No	Yes	The campaign for this email flow.
Email.ContactList	Contact	No	Yes	The contact that connects to the email flow.
Email.ContactID	Contact	No	Yes	The ID of the contact that connects to the flow.
Email.ConversationID	String	No	Yes	The identifier of the active email interaction.
Email.ExternalContactId	String	No	Yes	A unique identifier for the external contact. Note: Architect does not support multiple external contact IDs. It selects the first contact on the conversation based on startDate.
Email.ExternalTag	String	No	Yes	The external tag for the active call.
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	Boolean	No	Yes	Whether the email was generated automatically; for example, an out-of-office reply.

Showing results

1 - 10 of 36

Showentries

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.ExternalContactId	String	No	Yes	A unique identifier for the external contact. Note: Architect does not support multiple external contact IDs. It selects the first contact on the conversation based on startDate.
Call.ExternalTag	String	No	Yes	The external tag 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.LastCollectionMode	String	No	Yes	Holds the collection mode for the customer’s most recent input. The system overwrites the value each time the customer provides a new input. Valid values are the strings “speech”or “dtmf.” If the customer has not provided any input, Architect sets this variable to “NOT_SET.”
Call.RemoteName	String	No	Yes	Remote name for the active call.
Flow.InvocationData	String	No	Yes	The invocation data supplied when the flow starts.

Showing results

1 - 10 of 22

Showentries

Name	Type	Collection?	Read Only?	Description
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.
Message.Campaign	Campaign	No	Yes	The campaign for the flow.
Message.ContactID	String	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.ExternalContactId	String	No	Yes	A unique identifier for the external contact. Note: Architect does not support multiple external contact IDs. It selects the first contact on the conversation based on startDate.
Message.ExternalTag	String	No	Yes	The external tag for the active call.
Message.IsAuthenticated	Boolean	No	Yes	Returns a value that indicates whether the message is authenticated. True if the authentication was requested for the message when it enters the queue; otherwise, false.

Showing results

1 - 10 of 32

Showentries

Name	Type	Collection?	Read Only?	Description
Call.ExternalContactId	String	No	Yes	A unique identifier for the external contact. Note: Architect does not support multiple external contact IDs. It selects the first contact on the conversation based on startDate.
Menu.LastCollectionNoInput	String	No	Yes	Returns whether or not there was no user input detected when handling the last menu or sub-menu configured on the flow. At flow runtime, returns a NOT_SET Boolean if the execution has not yet solicited any user input menu choice.
Menu.LastCollectionNoMatch	String	No	Yes	Returns whether or not a caller input did not match a menu choice. At flow runtime, returns a NOT_SET Boolean if the execution has not yet solicited any user input menu choice.
Voicemail.DebugEntityType	String	No	Yes	When executing the flow following a debug publish, this variable contains the entity type being debugged or tested. This variable is ignored for normal (non-debug) executions.
Voicemail.DebugGroup	String	No	Yes	When executing the flow following a debug publish and the Voicemail.DebugEntityType is "Group," this variable contains the group being debugged or tested. This variable is ignored for normal (non-debug) executions, and debug executions where Voicemail.DebugEntityType is not "Group..
Voicemail.DebugQueue	String	No	Yes	When executing the flow following a debug publish, and the Voicemail.DebugEntityType is "Queue," this variable contains the queue being debugged or tested. This variable is ignored for normal (non-debug) executions, and debug executions where Voicemail.DebugEntityType is not "Queue."
Voicemail.DebugUser	String	No	Yes	When executing the flow following a debug publish, and the Voicemail.DebugEntityType is "User," this variable contains the user being debugged or tested. This variable is ignored for normal (non-debug) executions, and debug executions where Voicemail.DebugEntityType is not "User."
Voicemail.Enabled	Boolean	No	Yes	True if voicemail is enabled for the target entity.
Voicemail.EntityName	String	No	Yes	The textual name of the target entity.
Voicemail.EntityNameAudio	String	No	Yes	The target entity's custom name audio, as recorded in the Telephony User Interface (TUI). Recording a name is optional, so this variable may be NOT_SET.

Showing results

1 - 10 of 16

Showentries

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, or screeenShare. 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	ExternalContact	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.

Showing results

1 - 10 of 24

Showentries

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.
Chat.JourneyContext	String	No	Yes	The journey context associated with this chat.
Chat.JourneyContext.customer	String	No	Yes	The customer associated with the journey.
Chat.JourneyContext.customer.id	String	No	Yes	A unique identifier for the customer journey.
Chat.JourneyContext.customer.idType	Integer	No	Yes	The identification type of the customer journey.
Chat.JourneyContext.customerSession	String	No	Yes	The customer session associated with the customer journey.
Chat.JourneyContext.customerSession.id	String	No	Yes	A unique identifier for the customer journey session.
Chat.JourneyContext.customerSession.type	String	No	Yes	The identification type of the customer journey session.

Showing results

1 - 10 of 25

Showentries

Name	Type	Collection?	Read Only?	Description
Workflow.Language	String	No	Yes	The lowercase IETF language tag for the language in which the flow is currently running.
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.
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).

Showing results

1 - 10 of 11

Showentries

Name	Type	Collection?	Read Only?	Description
Flow.IsTest	Boolean	No	Yes	Indicates whether or not 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.
Session.ActiveIntent	String	No	Yes	The currently active intent for the session.
Session.ChannelType	String	No	Yes	The channel type of the conversation associated with this bot flow instance. Valid values are "call," "chat," or "messaging."
Session.ConversationID	String	No	Yes	The ID of the conversation associated with this bot flow instance.
Session.ExternalContactId	String	No	Yes	A unique identifier for the external contact. Note: Architect does not support multiple external contact IDs. It selects the first contact on the conversation based on startDate.
Session.IsAuthenticated	Boolean	No	Yes	Indicates whether an authentication request that is sent using the Ask to Authenticate action is processed or not. If the action is successful, it indicates that the user is authenticated. If the Ask to Authenticate action has not yet run, the value is NULL.
Session.Language	String	No	Yes	The IETF language tag lowercase string value set on the current interaction. Note: Within bot flows, construct comparisons with IETF language tag string values in a case-insensitive manner.
Session.LastCollectionConfidence	Decimal	No	Yes	The participant's most recent utterance confidence in an Ask for action, excluding those for built-in confirmation or disambiguation questions. If no such utterance exists, then this is a NOT_SET decimal. Note: This variable applies specifically to automatic speech recognition (ASR) confidence, not natural language understanding (NLU) confidence. The variable, Session.LastNLUCollectionConfidence, can be used for accessing NLU confidence.

Showing results

1 - 10 of 28

Showentries

Name	Type	Collection?	Read Only?	Description
Flow.IsTest	Boolean	No	Yes	Indicates whether or not 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.
Form.FullSurvey	SurveyForm	No	Yes	The survey form associated with the voice survey flow.
Form.QuestionGroup{x}	SurveyQuestionGroup	No	Yes	The specific {x} question group in the survey form associated with the voice survey flow.
Form.Group{x}_Question{y}	SurveyQuestion	No	Yes	The specific {y} question in the specific {x} question group in the survey form associated with the voice survey flow.
Session.ChannelType	String	No	Yes	The channel type of the conversation associated with the voice survey flow instance. It has one valid value: 'call'.
Session.ConversationId	String	No	Yes	The ID of the conversation associated with the voice survey flow instance.
Session.InvocationData	String	No	Yes	The invocation data that the Set Post-Flow action provides for the voice survey flow it launches. If no invocation data is available, this returns a `NOT_SET` JSON value.
Session.Language	String	No	Yes	The lowercase IETF language tag for the language in which the flow is currently running. If there is no current flow language, this returns a `NOT_SET` string.

Showing results

1 - 10 of 23

Showentries

Name	Type	Collection?	Read Only?	Description
Email. ACDSkills	Skill	No	Yes	Holds the ACD skills for the conversation
Email.Campaign	Campaign	No	Yes	The campaign for this email flow.
Email.ContactList	Contact	No	Yes	The contact that connects to the email flow.
Email.ContactID	Contact	No	Yes	The ID of the contact that connects to the flow.
Email.ConversationID	String	No	Yes	The identifier of the active email interaction.
Email.ExternalContactId	String	No	Yes	A unique identifier for the external contact. Note: Architect does not support multiple external contact IDs. It selects the first contact on the conversation based on startDate.
Email.EstimatedWaitTime	Duration	No	Yes	The current queue estimated wait time for the email.
Email.ExternalTag	String	No	Yes	The external tag for the active call.
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.

Showing results

1 - 10 of 41

Showentries

Name	Type	Collection?	Read Only?	Description
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.
Message.ACDSkills	Skill	Yes	Yes	Holds the ACD skills for the conversation.
Message.Campaign	Campaign	No	Yes	The campaign for the flow.
Message.ContactID	String	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.CurrentQueue	Queue	No	Yes	Reflects the current queue for the message.
Message.EstimatedWaitTime	Duration	No	Yes	The current queue's estimated wait time for the message.

Showing results

1 - 10 of 44

Showentries

Name	Type	Collection?	Read Only?	Description
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.Conversation	Enum	No	Yes	Information about the conversation associated with the flow. A list of available conversation types. For more information, see `mediatype` in Conversation Data model in the Genesys Cloud Developer Center.
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).

Showing results

1 - 10 of 164

[NEXT] Was this article helpful?

Get user feedback about articles.

Loading...

Architect built-in variables

[NEXT] Was this article helpful?