This guide is for Flex UI 1.x.x and channels that use Programmable Chat and Proxy. If you are using Flex UI 2.x.x or you are starting out, we recommend that you build with Flex Conversations.
A Flex Flow is the logic linking a contact identity (e.g. SMS-enabled phone number or WhatsApp number) to Flex.
This page details the Flex Flow API Resource. Check out the additional documentation to learn more about working with Flex Flows.
account_sid
type: SID<AC>The SID of the Account that created the Flex Flow resource and owns this Workflow.
^AC[0-9a-fA-F]{32}$
34
34
date_created
type: string<date-time>The date and time in GMT when the resource was created specified in ISO 8601 format.
date_updated
type: string<date-time>The date and time in GMT when the resource was last updated specified in ISO 8601 format.
sid
type: SID<FO>The unique string that we created to identify the Flex Flow resource.
^FO[0-9a-fA-F]{32}$
34
34
chat_service_sid
type: SID<IS>The SID of the chat service.
^IS[0-9a-fA-F]{32}$
34
34
channel_type
type: enum<string>The channel type. One of web
, facebook
, sms
, whatsapp
, line
or custom
. By default, Studio’s Send to Flex widget passes it on to the Task attributes for Tasks created based on this Flex Flow. The Task attributes will be used by the Flex UI to render the respective Task as appropriate (applying channel-specific design and length limits). If channelType
is facebook
, whatsapp
or line
, the Send to Flex widget should set the Task Channel to Programmable Chat.
web
sms
facebook
whatsapp
line
custom
integration_type
type: enum<string>The software that will handle inbound messages. Integration Type can be: studio
, external
, or task
.
studio
external
task
long_lived
type: booleanWhen enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to false
.
janitor_enabled
type: booleanWhen enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to false
.
POST https://flex-api.twilio.com/v1/FlexFlows
FriendlyName
type: stringRequiredA descriptive string that you create to describe the Flex Flow resource.
ChatServiceSid
type: SID<IS>RequiredThe SID of the chat service.
^IS[0-9a-fA-F]{32}$
34
34
ChannelType
type: enum<string>RequiredThe channel type. One of web
, facebook
, sms
, whatsapp
, line
or custom
. By default, Studio’s Send to Flex widget passes it on to the Task attributes for Tasks created based on this Flex Flow. The Task attributes will be used by the Flex UI to render the respective Task as appropriate (applying channel-specific design and length limits). If channelType
is facebook
, whatsapp
or line
, the Send to Flex widget should set the Task Channel to Programmable Chat.
web
sms
facebook
whatsapp
line
custom
IntegrationType
type: enum<string>The software that will handle inbound messages. Integration Type can be: studio
, external
, or task
.
studio
external
task
Integration.FlowSid
type: SID<FW>The SID of the Studio Flow. Required when integrationType
is studio
.
^FW[0-9a-fA-F]{32}$
34
34
Integration.Url
type: string<uri>The URL of the external webhook. Required when integrationType
is external
.
Integration.WorkspaceSid
type: SID<WS>The Workspace SID for a new Task. Required when integrationType
is task
.
^WS[0-9a-fA-F]{32}$
34
34
Integration.WorkflowSid
type: SID<WW>The Workflow SID for a new Task. Required when integrationType
is task
.
^WW[0-9a-fA-F]{32}$
34
34
Integration.Channel
type: stringThe 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.Timeout
type: integerThe Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when integrationType
is task
, not applicable otherwise.
Integration.Priority
type: integerThe Task priority of a new Task. The default priority is 0. Optional when integrationType
is task
, not applicable otherwise.
Integration.CreationOnMessage
type: booleanIn 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.
LongLived
type: booleanWhen enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to false
.
JanitorEnabled
type: booleanWhen enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to false
.
Integration.RetryCount
type: integerThe number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when integrationType
is studio
or external
, not applicable otherwise.
The Studio Usage Guide is a helpful introduction to Studio Flows and the general idea of how Studio works. If you're looking for a simple way to power your Flex Flow, an underlying Studio Flow might be the right way to go!
When you receive an inbound message, the Flex Flow will make a POST
request containing the message body and some metadata to your chosen webhook.
GET https://flex-api.twilio.com/v1/FlexFlows/{Sid}
Sid
type: SID<FO>The SID of the Flex Flow resource to fetch.
^FO[0-9a-fA-F]{32}$
34
34
GET https://flex-api.twilio.com/v1/FlexFlows
FriendlyName
type: stringThe friendly_name
of the Flex Flow resources to read.
PageSize
type: integerHow many resources to return in each list page. The default is 50, and the maximum is 1000.
1
Page
type: integerThe page index. This value is simply for client state.
0
POST https://flex-api.twilio.com/v1/FlexFlows/{Sid}
Sid
type: SID<FO>The SID of the Flex Flow resource to update.
^FO[0-9a-fA-F]{32}$
34
34
FriendlyName
type: stringA descriptive string that you create to describe the Flex Flow resource.
ChatServiceSid
type: SID<IS>The SID of the chat service.
^IS[0-9a-fA-F]{32}$
34
34
ChannelType
type: enum<string>The channel type. One of web
, facebook
, sms
, whatsapp
, line
or custom
. By default, Studio’s Send to Flex widget passes it on to the Task attributes for Tasks created based on this Flex Flow. The Task attributes will be used by the Flex UI to render the respective Task as appropriate (applying channel-specific design and length limits). If channelType
is facebook
, whatsapp
or line
, the Send to Flex widget should set the Task Channel to Programmable Chat.
web
sms
facebook
whatsapp
line
custom
IntegrationType
type: enum<string>The software that will handle inbound messages. Integration Type can be: studio
, external
, or task
.
studio
external
task
Integration.FlowSid
type: SID<FW>The SID of the Studio Flow. Required when integrationType
is studio
.
^FW[0-9a-fA-F]{32}$
34
34
Integration.Url
type: string<uri>The URL of the external webhook. Required when integrationType
is external
.
Integration.WorkspaceSid
type: SID<WS>The Workspace SID for a new Task. Required when integrationType
is task
.
^WS[0-9a-fA-F]{32}$
34
34
Integration.WorkflowSid
type: SID<WW>The Workflow SID for a new Task. Required when integrationType
is task
.
^WW[0-9a-fA-F]{32}$
34
34
Integration.Channel
type: stringThe 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.Timeout
type: integerThe Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when integrationType
is task
, not applicable otherwise.
Integration.Priority
type: integerThe Task priority of a new Task. The default priority is 0. Optional when integrationType
is task
, not applicable otherwise.
Integration.CreationOnMessage
type: booleanIn 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.
LongLived
type: booleanWhen enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to false
.
JanitorEnabled
type: booleanWhen enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to false
.
Integration.RetryCount
type: integerThe number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when integrationType
is studio
or external
, not applicable otherwise.
DELETE https://flex-api.twilio.com/v1/FlexFlows/{Sid}
Sid
type: SID<FO>The SID of the Flex Flow resource to delete.
^FO[0-9a-fA-F]{32}$
34
34