|
|
| Line 1: |
Line 1: |
| = Variables= | | = Variables= |
| This section describes the variables that are used in Bright Pattern Contact Center [[contact-center-administrator-guide/WorkflowEntries|workflows]] and [[scenario-builder-reference-guide/ScenarioBuilderOverview|scenarios]].
| | In Bright Pattern Contact Center, variables are available for use in both [[contact-center-administrator-guide/WorkflowEntries|workflows]] and [[scenario-builder-reference-guide/ScenarioBuilderOverview|scenarios]]. |
|
| |
|
| Variables are accessed using the common ''$(varname)'' format. They can be used in [[scenario-builder-reference-guide/IntegerExpressions|integer]] and [[scenario-builder-reference-guide/StringExpressions|string]] expressions.
| | All variables are referenced using the format ''$(variableName)'', and can be used in [[scenario-builder-reference-guide/IntegerExpressions|integer]] and [[scenario-builder-reference-guide/StringExpressions|string]] expressions. |
|
| |
|
| == Common Variables ==
| | For complete lists of the variables available in ''Scenarios'' or ''Workflows'', refer to the following: |
| === $(user.id) ===
| |
| ''$(user.id)'' specifies the agent's ID if the workflow is started due to agent action. | |
|
| |
|
| === $(user.loginId) ===
| | * [[Workflow-builder-reference-guide/Variables|Workflow Variable Reference]] |
| ''$(user.loginId)'' specifies the agent's login ID if the workflow is started due to agent action.
| |
|
| |
|
| === $(user.team) ===
| | * [[Scenario-builder-reference-guide/Reference/VariablesandExpressions/Variables|Scenario Variable Reference]] |
| ''$(user.team)'' is the name of the team to which the user is assigned.
| |
| | |
| === $(user.firstName) ===
| |
| ''$(user.firstName)'' specifies the agent's first name.
| |
| | |
| === $(user.lastName) ===
| |
| ''$(user.lastName)'' specifies the agent's last name.
| |
| | |
| === $(item.caseId) ===
| |
| ''$(item.caseId)'' specifies the case ID of the interaction, if available.
| |
| | |
| === $(item.caseNumber) ===
| |
| ''$(item.caseNumber)'' specifies the case number of the interaction, if available.
| |
| | |
| === $(item.contactId) ===
| |
| ''$(item.contactId)'' specifies the contact ID of the customer, if available.
| |
| | |
| === $(item.firstName) ===
| |
| ''$(item.firstName)'' specifies the first name of the customer, if available.
| |
| | |
| === $(item.lastName) ===
| |
| ''$(item.lastName)'' specifies the last name of the customer, if available.
| |
| | |
| === $(global_interaction_id) ===
| |
| ''$(global_interaction_id)'' specifies the [[reporting-reference-guide/GlobalInteractionIdentifier|Global interaction identifier]]. This variable is also known as ''$(item.globalInteractionId)''.
| |
| | |
| '''Note''': This variable is available in scenarios.
| |
| | |
| === $(agentsBlacklistedForRouting) ===
| |
| The [[Scenario-builder-reference-guide/ScenarioBlocks/FindAgent|Find Agent block]] will not route interactions to any agent specified in this variable. Agents to blacklist from routing are expressed as a list of comma-separated agent IDs or agent configuration UUIDs, for example:<syntaxhighlight>
| |
| john.doe,48AD5207-CCD3-4765-9429-D092DF7526DE,wanda.bui
| |
| </syntaxhighlight>By default, this variable is empty. The [[Scenario-builder-reference-guide/ScenarioBlocks/SetVariable|Set Variable block]] can be used to assign a value.
| |
| | |
| This variable can be used in both voice and chat scenarios.
| |
| | |
| == For Voice ==
| |
| === $(LanguageAsked) ===
| |
| ''$(LanguageAsked)'' specifies whether the customer asked for a specific language (e.g., "Yes").
| |
| | |
| === $(NPS_raw) ===
| |
| ''$(NPS_raw)'' specifies the Net Promoter Score (NPS) value (e.g., "11").
| |
| | |
| === $(contact_satisfaction) ===
| |
| ''$(contact_satisfaction)'' specifies the customer's contact satisfaction rating (e.g., "1").
| |
| | |
| === $(destination) ===
| |
| ''$(destination)'' specifies the destination for the [[scenario-builder-reference-guide/ConnectCall|Connect Call]] block (e.g., "2042").
| |
| | |
| === $(first_call) ===
| |
| ''$(first_call)'' specifies whether this voice interaction is the first placed call (e.g., "1").
| |
| | |
| === $(screenpopData) ===
| |
| ''$(screenpopData)'' specifies the list of the screen pop data received or set by interactive voice response (IVR). An actual list of available screen pop data elements depends on the particular IVR and integration.
| |
| | |
| === $(item.ANI)===
| |
| ''$(item.ANI)'' specifies the Automatic Number Identification (ANI), a telephone company service providing a calling party with a number of the calling party. "ANI" is often used instead of “calling party number.”
| |
| | |
| === $(item.DNIS) ===
| |
| ''$(item.DNIS)'' specifies the Dialed Number Identification Service (DNIS), a telephone company service providing the called party with a number that was dialed by the calling party. "DNIS" is often used as a shorthand for "called party number."
| |
| | |
| === $(item.cnam) ===
| |
| ''$(item.cnam)'' specifies the customer name.
| |
| | |
| === $(item.customerPhone) ===
| |
| ''$(item.customerPhone)'' specifies the customer phone number. This variable enables passing customer phone information from scenarios of primary inbound and outbound customer calls to scenarios of the associated consultations and blind transfers.
| |
| * In scenarios launched for new incoming calls, its value matches the value of the ''$(item.from)'' variable.
| |
| * In scenarios launched for new outgoing calls, its value matches the value of the ''$(item.to)'' variable.
| |
| * In scenarios launched for consult calls and blind transfers, the value of the ''$(item.customerPhone)'' is inherited from the scenarios of the associated primary calls.
| |
| | |
| === $(item.from) ===
| |
| ''$(item.from)'' specifies the origination address (i.e., phone number or chat user display name). This variable is also known as ''ANI''.
| |
| | |
| === $(item.interactionId) ===
| |
| ''$(item.interactionId)'' specifies the interaction identifier.
| |
| | |
| === $(item.media) ===
| |
| ''$(item.media)'' specifies the media type (e.g., "voice").
| |
| | |
| === $(outbound_data) ===
| |
| ''$(outbound_data)'' contains data from calling lists and is available if the workflow is triggered from outbound campaign.
| |