Built-in script variables

Built-in variables are available when a read-only text, button, checkbox, radio button, link, or markdown has focus in the script editor. 

For a list of built-in variables, click Variables .

Built-in variables provide information about objects that the system tracks automatically, such as the agent’s name or duration of the current call. For example, if you select Scripter.Agent Name from the list, Scripter inserts a placeholder for that variable into the component. Two sets of curly braces enclose the variable name: {{Scripter.Agent Name}}.

You can mix manually typed text with variables. For example:

Outstanding agent {{Scripter.Agent Name}} has been on this call for {{Scripter.Agent Call Duration}} minutes.

Selectable variables:

  • Variables with the Scripter prefix are available to all scripts, whether inbound or outbound.

  • Variables with the Outbound prefix insert placeholders for columns in the contact list that is associated with the script. Outbound variables only appear if you enable a script’s Outbound property.

  • Custom variables that you create.

Scripter variables:

{{Scripter.Agent Call Duration}}—total time that the agent was on the call.

{{Scripter.Agent Call Start Time}}—time when the call was connected to the agent.

{{Scripter.Agent Communication ID}}—the ID of the agent’s current communication.

{{Scripter.Agent Email}}—agent’s email address.

{{Scripter.Agent Formatted Number}}—formatted number that the contact sees as the agent’s caller ID.

{{Scripter.Agent Locale}}—agent’s chosen language code, such as: en-US: English; fr: French; and es: Spanish, based on the agent’s language selection.

{{Scripter.Agent Id}}—agent’s Genesys Cloud ID (UUID).

{{Scripter.Agent Name}}—name entered for the agent user.

{{Scripter.Agent Participant ID}}—agent’s ID.

{{Scripter.Customer Call Duration}}—total time the customer has been on the call.

{{Scripter.Customer Call Start Time}}—time when the call started.

{{Scripter.Customer Communication ID}}—ID of customer’s current communication.

{{Scripter.Customer Formatted Number}}—customer’s formatted phone number.

{{Scripter.Customer Participant ID}}—customer’s ID.

{{Scripter.Interaction Id}}—unique ID assigned to the interaction. This variable is the same as the conversationID in the Genesys Cloud API.

{{Scripter.Interaction State}}—current state of the interaction. See Interaction states. 

{{Scripter.Interaction Type}}—type of interaction: for example, call, chat, email, or others.

{{Scripter.Message Type}}—message type for messaging services: for example, sms, facebook, twitter, line.

{{Scripter.Page Is Invalid}}—true or false, whether the script contains an error.

{{Scripter.Queue ID}}—ID of the queue this interaction is on.

{{Scripter.Queue Name}}—name of the queue this interaction is on.

{{Scripter.Raw Interaction State}}—untranslated current state of the interaction. See Interaction states. 

{{Scripter.Raw Interaction Type}}—untranslated type of interaction: for example, call, chat, email, or others.

{{Scripter.Script ID}}—ID of this script.

Note: Some Scripter.{{}} variables are translated to the preferred language that the agents set. For example, the {{Scripter.Interaction State}} variable changes from “connected” in English to “Connecte” in French. So in use, the logic with “connected” as the keyword works only for the agents with English as their preferred language. Use the Raw versions for programmatic usages, as they are not translated.

Outbound variables:

{{Outbound.Campaign ID}}—ID of the campaign associated with this script’s Outbound property.

{{Outbound.Campaign Name}}—Name of the outbound campaign associated with this script’s Outbound property.

Note: To access a campaign’s name for the Outbound.Campaign Name variable, users must have the Outbound > Campaign > View permission and the Outbound > Campaign > Search permission.

{{Outbound.Contact ID}}—ID number of the outbound contact.

Chat variables:

{{Chat.Chat Room ID}}—ID of the chat room.

{{Chat.Customer Chat ID}}—The Genesys Cloud ID for this chat interaction. 

The Genesys Cloud web chat widget passes the values for the following variables. If your web chat developers do not assign values to them, they do not have a value.

{{Chat.Customer Email}}—The customer’s email address. 

{{Chat.Customer First Name}}—The customer’s first name.

{{Chat.Customer Last Name}}—The customer’s last name.

{{Chat.Customer Street}}—The customer’s street.

{{Chat.Customer City}}—The customer’s city.

{{Chat.Customer Postal Code}}—The customer’s postal code, for example: 50163.

{{Chat.Customer State}}—The customer’s state.

{{Chat.Customer Phone Number}}—The customer’s phone number.

{{Chat.Customer Phone Type}}—The customer’s phone type.

{{Chat.Customer ID}}—The ID for this customer, set by your web chat developers. For example, you can configure web chat to supply the account number that your organization keeps for that user. As a result, the agent can use it to look up the customer in a database.

Email variables:

{{Email.Customer Email Address}}—The address that the customer used.

{{Email.Subject}}—The subject line of the customer’s email.

UUI variables:

{{UUI.UUIData}}—User to User Information (UUI) is the exchange or passage of data that is unrelated to the call from one application to another. Scripts support UUI data exchange. To use UUI data in scripts, enable the script’s UUI property, enable the User to User Information settings on the trunk and set a UUI Data action.