System Variables

Studio automatically creates system variables to capture information from the task as it runs.

While testing the call flow, you can assign values to system variables. Use the Start node. Remove these assignments from the start node when testing is complete.

Variable Tasks

Description

sys.ANI

Voice, Messaging, ChatBot, and What's App

For an inbound call, stores the number of the incoming call.

For an outbound call, stores the number called.

sys.DNIS

Voice, Messaging, ChatBot, and What's App

For an inbound message, stores the number sending the incoming message.

For an outbound message, stores the number messaged.

sys.UUID

All

Stores the universal unique identifier of the event.

sys.MESSAGE_TEXT

Messaging, ChatBot, and Whats App

Stores the message text for inbound and outbound messages.

sys.MESSAGE_JSON

ChatBot

Stores complex data in JSON format, such as rich media added to a conversation through the Conversationnode, Advanced tab.

sys.CALL_START_TIME

Voice

Stores the time the script started to run. The timestamp is recorded in milliseconds.

sys.REGION

All

Stores the application region where the code is deployed. An example is US.

sys.POP

All

Stores the application pop where the code is deployed. Examples are VIR and CHI.

sys.ServiceProviderName

All

Stores the name of the service provider that owns the task.

sys.ServiceProviderId

All

Stores the ID of the service provider that owns the task.

sys.AccountName

All

Stores the name of the account that owns the task.

sys.AccountId

All

Stores the ID of the account that owns the task.

sys.TaskName

All

Stores the name of the task to initiate the call flow.

sys.TaskId

All

Stores the ID of the task to initiate the call flow.

sys.CurrentTaskId

All

Stores the ID of the task currently being processed. Where tasks are linked using Link Task, the task currently being processed may not be the same as the task to initiate the call flow.

sys.CurrentTaskName

All

Stores the name of the task currently being processed. Where tasks are linked using Link Task, the task currently being processed may not be the same as the task to initiate the call flow.

sys.TypeDetected

All

Stores the task type. The task type could be voice, messaging, chatbot, whatsapp, or workflow.

sys.LAST_MESSAGE_MEDIA_TYPE

ChatBot and WhatsApp

Stores the rich media type most recently received in the conversation. The rich media type could be link, reply, postback, or location. For more information, see Conversation.

sys.LAST_MESSAGE_MEDIA

ChatBot and WhatsApp

Stores the URL of the attached rich media.

sys.LocationLatitude

ChatBot

Stores the latitude coordinate of the caller. See Conversation.

sys.LocationLongitude

ChatBot

Stores the longitude coordinate of the caller. See Conversation.

sys.DOMAIN_ID

Voice

For an incoming call from VCC, stores the VCC domain ID.