Function: fn!twilioAvailability
Allows agent to switch their availability settings for Twilio.
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. |
Supported Channels | supportedChannels | List of Text String | Determines which communication channels are supported. Valid values: "VOICE", "SMS", "CHAT". |
Auto Answer | autoAnswer | Boolean | Determines if the user is automatically connected to an incoming phone call. Default: true. |
On Availability Change | onAvailabilityChange | List of Save | One or more variables that are updated when availability has been changed. The value to be saved will be the latest availability that has been set. Use a!save() to save a modified or alternative value to a variable. |
Outbound Call | outboundCall | Boolean | Determines if the user has the ability to place an outbound call. Default: false. |
Item List Value | itemListValue | List of Dictionary | A list of definitions that represents each item in the tab list component. |
Item List Save Into | itemListSaveInto | List of Save | One or more variables that are updated with the itemList value when the user changes it. Use a!save() to save a modified or alternative value to a variable. |
Record Call | recordCall | Boolean | Determines whether phone calls will be recorded by Twilio. Default: false. |
Chat Start Audio | chatStartAudio | Boolean | Determines whether there will be an audio notification at the start of a chat or SMS conversation. The audio will be dismissed when the user clicks in the text response box. Default: false. |
On Task Dismiss | onTaskDismiss | List of Save | One or more variables that are updated when a task is cancelled, rejected, or timed out. This save array will only be executed when autoAnswer is set to false. The value to be saved will be a dictionary representing the dismissed task. Use a!save() to save a modified or alternative value to a variable. |
On New Interaction | onNewInteraction | List of Save | One or more variables that are updated when a new interaction is accepted. The value to be saved will be a dictionary representing the loaded call or chat. The dictionary will have two values: the interaction type and 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 Interaction Update | onInteractionUpdate | List of Save | One or more variables that are updated when an interaction is updated. The value to be saved will be a dictionary representing the loaded call or chat. The dictionary will have two values: the interaction type and 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. |
Is Debug | isDebug | Boolean | Determines whether debug mode is enabled for browser console logging. This parameter should only be set to true in non-production environments. Default: false. |
Twilio Client Region | twilioClientRegion | Text | Specifies which Twilio Data Center to use when an agent receives or initiates a call. If left blank, the component will use Twilio's global low latency (GLL) region selection. |
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 Concurrency Lock | onConcurrencyLock | List of Save | Determines whether the component is disabled due to an active session in another tab. A value of true will be provided when the component is hidden and is not evaluated, else a value of false will be provided. |