Create flex flow

POST /v1/FlexFlows

Account sid auth token

Flex Flow

application/x-www-form-urlencoded

Body

FriendlyName string Required

A descriptive string that you create to describe the Flex Flow resource.
ChatServiceSid string Required

The SID of the chat service.

Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.
ChannelType string Required

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.

Values are web, sms, facebook, whatsapp, line, or custom.
ContactIdentity string

The channel contact's Identity.
Enabled boolean

Whether the new Flex Flow is enabled.
IntegrationType string

The software that will handle inbound messages. Integration Type can be: studio, external, or task.

Values are studio, external, or task.
Integration.FlowSid string

The SID of the Studio Flow. Required when integrationType is studio.

Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FW[0-9a-fA-F]{32}$.
Integration.Url string(uri)

The URL of the external webhook. Required when integrationType is external.
Integration.WorkspaceSid string

The Workspace SID for a new Task. Required when integrationType is task.

Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.
Integration.WorkflowSid string

The Workflow SID for a new Task. Required when integrationType is task.

Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WW[0-9a-fA-F]{32}$.
Integration.Channel string

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.Timeout integer

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.Priority integer

The Task priority of a new Task. The default priority is 0. Optional when integrationType is task, not applicable otherwise.
Integration.CreationOnMessage boolean

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.
LongLived boolean

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.
JanitorEnabled boolean

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.
Integration.RetryCount integer

The 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.

Responses

201 application/json

Created
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
  
  Specify the origin(s) allowed to access the resource
- Access-Control-Allow-Methods string
  
  Specify the HTTP methods allowed when accessing the resource
- Access-Control-Allow-Headers string
  
  Specify the headers allowed when accessing the resource
- Access-Control-Allow-Credentials boolean
  
  Indicates whether the browser should include credentials
- Access-Control-Expose-Headers string
  
  Headers exposed to the client
Hide response attributes Show response attributes object
- account_sid string | null
  
  The SID of the Account that created the Flex Flow resource and owns this Workflow.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- date_created string(date-time) | null
  
  The date and time in GMT when the resource was created specified in ISO 8601 format.
- date_updated string(date-time) | null
  
  The date and time in GMT when the resource was last updated specified in ISO 8601 format.
- sid string | null
  
  The unique string that we created to identify the Flex Flow resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FO[0-9a-fA-F]{32}$.
- friendly_name string | null
  
  The string that you assigned to describe the resource.
- chat_service_sid string | null
  
  The SID of the chat service.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.
- channel_type 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.
  
  Values are web, sms, facebook, whatsapp, line, or custom.
- contact_identity string | null
  
  The channel contact's Identity.
- enabled boolean | null
  
  Whether the Flex Flow is enabled.
- integration_type string
  
  The software that will handle inbound messages. Integration Type can be: studio, external, or task.
  
  Values are studio, external, or task.
- integration
  
  An object that contains specific parameters for the integration.
- long_lived boolean | null
  
  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.
- janitor_enabled boolean | null
  
  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.
- url string(uri) | null
  
  The absolute URL of the Flex Flow resource.

POST /v1/FlexFlows

curl \
 --request POST 'https://flex-api.twilio.com/v1/FlexFlows' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Enabled=true&LongLived=true&ChannelType=sms&FriendlyName=friendly_name&ChatServiceSid=ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&JanitorEnabled=true&ContactIdentity=12345&IntegrationType=studio&Integration.FlowSid=FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Integration.RetryCount=1'

Request example

{"Enabled"=>true, "LongLived"=>true, "ChannelType"=>"sms", "FriendlyName"=>"friendly_name", "ChatServiceSid"=>"ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "JanitorEnabled"=>true, "ContactIdentity"=>"12345", "IntegrationType"=>"studio", "Integration.FlowSid"=>"FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "Integration.RetryCount"=>1}

Response examples (201)

{
  "sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "enabled": true,
  "long_lived": true,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "integration": {
    "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "retry_count": 1
  },
  "channel_type": "sms",
  "date_created": "2016-08-01T22:10:40Z",
  "date_updated": "2016-08-01T22:10:40Z",
  "friendly_name": "friendly_name",
  "janitor_enabled": true,
  "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "contact_identity": "12345",
  "integration_type": "studio"
}