Twilio Interaction Controls Component

Twilio interaction controls component

Function: fn!twilioControls

Provides agents with controls needed to handle an interaction with Twilio.

Parameters

Name Keyword Type Description  
Label label Text Text to display as the field label.  
Label Position labelPosition Text Determines where the label appears. Valid values: "ABOVE" (default), "ADJACENT", "COLLAPSED".  
Instructions instructions Text Supplemental text about this field.  
Help Tooltip helpTooltip Text Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".  
Required required Boolean Determines if a value is required to submit the form. Default: false.  
Disabled disabled Boolean Determines if the user is prevented from interacting with the field. Default: false.  
Validations validations List of Text String Validation errors to display below the field when the value is not null.  
Height height Text Determines the layout height. Valid values: “SHORT”, “MEDIUM”, “TALL”, “AUTO” (default).  
Visibility showWhen Boolean Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.  
Twilio Connected System twilioConnectedSystem Connected System The connected system used to communicate with Twilio. This should be created as a Twilio Connected System.  
Twilio Worker SID twilioWorkerSid Text The Twilio Worker SID (e.g., "WK…") for the Twilio worker.  
Twilio Workflow SID twilioWorkflowSid Text The Twilio Workflow SID (e.g., "WW…") to use for outbound calls. If no value is specified, the outbound calling capabilities will be disabled.  
Twilio Task SID twilioTaskSid Text The Twilio Task SID (e.g., “WT…”) that the component is connecting to.  
Interaction Type interactionType Text The interaction type for the task SID the component is connecting to.  
Interaction State interactionState Text The interaction state for the interaction ID the component is connecting to.  
Display Country Code displayCountryCode Boolean Determines whether the phone number that is passed from Twilio will be formatted to display the country code of the caller. Default: false.  
On Task Load onTaskLoad List of Save One or more variables that are updated when a task is loaded. The value to be saved will be a dictionary representing the loaded task, including fields for taskSid, assignmentStatus, taskType, and attributes (which contains additional details about the task). Use a!save() to save a modified or alternative value to a variable.  
On Communication Complete onCommunicationComplete List of Save One or more variables that are updated when the call or chat ends. The value to be saved will be the current task SID. Use a!save() to save a modified or alternative value to a variable.  
On Task Complete onTaskComplete List of Save One or more variables that are updated when the Twilio task is completed. The value to be saved will be the current task SID. Use a!save() to save a modified or alternative value to a variable.  
Outbound Caller ID outboundCallerID Text The caller ID that is associated with the outgoing call. The value provided must be an E.164 formatted number that is either owned or verified by the Twilio account. If left blank, the caller ID will default to the first active number in Twilio.  
Outbound Suggestion outboundSuggestion Text A suggested phone number that will appear in the outbound dial pad. The number can be edited by the user before the call is placed.  
Default Country Code defaultCountryCode Integer If provided, prefixes a country code in front of the entered phone number for all outbound calls. If not provided, users will need to manually enter in a country code for each call that is placed.  
Chat Suggestion chatSuggestion Text A suggested chat message which will appear in the chat message window. The message can be edited by the user before being sent.  
On New Chat Message onNewChatMessage List of Save One or more variables that are updated when a new chat message is sent or received. The value to be saved will be a dictionary representing the new message, including fields for channelSid, isFromAgent, and message. Use a!save() to save a modified or alternative value to a variable.  
On Member Leave onMemberLeave List of Save One or more variables that are updated when a member leaves the chat. The value to be saved will be a dictionary representing the identity of the worker that left, member SID, channel SID, and member count of the channel. Use a!save() to save a modified or alternative value to a variable.  
On Hold onHold List of Save One or more variables that are updated when the agent clicks the hold button. The value to be saved will be a boolean representing whether the agent has put the caller on hold. Use a!save() to save a modified or alternative value to a variable.  
Open in Github

On This Page

FEEDBACK