The `identity` value that uniquely identifies the new resource's chat User.
chat_unique_name
string
Optional
The chat channel's unique name.
long_lived
bool
Optional
Whether to create the channel as long-lived.
pre_engagement_data
string
Optional
The pre-engagement data.
target
string
Optional
The Target Contact Identity, for example the phone number of an SMS.
task_attributes
string
Optional
The Task attributes to be added for the TaskRouter Task.
task_sid
string
Optional
The SID of the TaskRouter Task. Only valid when integration type is `task`. `null` for integration types `studio` & `external`
sid
string
Computed
The SID of the Flex chat channel resource to fetch.
twilio_flex_flex_flows_v1
Parameters
Name
Type
Requirement
Description
channel_type
string
Required
The channel type. Can be: `web`, `facebook`, `sms`, `whatsapp`, `line` or `custom`.
chat_service_sid
string
Required
The SID of the chat service.
friendly_name
string
Required
A descriptive string that you create to describe the Flex Flow resource.
contact_identity
string
Optional
The channel contact's Identity.
enabled
bool
Optional
Whether the new Flex Flow is enabled.
integration_channel
string
Optional
The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`.
integration_creation_on_message
bool
Optional
In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging.
integration_flow_sid
string
Optional
The SID of the Studio Flow. Required when `integrationType` is `studio`.
integration_priority
int
Optional
The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise.
integration_retry_count
int
Optional
The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3 (inclusive), default is 3. Optional when `integrationType` is `external`, not applicable otherwise.
integration_timeout
int
Optional
The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise.
integration_url
string
Optional
The URL of the external webhook. Required when `integrationType` is `external`.
integration_workflow_sid
string
Optional
The Workflow SID for a new Task. Required when `integrationType` is `task`.
integration_workspace_sid
string
Optional
The Workspace SID for a new Task. Required when `integrationType` is `task`.
integration_type
string
Optional
The software that will handle inbound messages. Integration Type can be: `studio`, `external`, or `task`.
janitor_enabled
bool
Optional
When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`.
long_lived
bool
Optional
When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`.