Create flex flow

POST /v1/FlexFlows

Flex Flow

Body

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

  • 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}$.

  • ContactIdentity string

    The channel contact's Identity.

  • Enabled boolean

    Whether the new Flex Flow is enabled.

  • FriendlyName string Required

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

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

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

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

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

  • 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.Url string(uri)

    The URL of the external webhook. Required when integrationType is external.

  • 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.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}$.

  • IntegrationType string

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

    Values are studio, external, or task.

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

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

Responses

  • 201

    Created

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

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

    • channel_type string | null

      The channel type

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

    • 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}$.

    • contact_identity string | null

      The channel contact's Identity

    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was last updated

    • enabled boolean | null

      Whether the Flex Flow is enabled

    • friendly_name string | null

      The string that you assigned to describe the resource

    • integration

      An object that contains specific parameters for the integration

    • integration_type string | null

      The software that will handle inbound messages.

      Values are studio, external, or task.

    • janitor_enabled boolean | null

      Remove active Proxy sessions if the corresponding Task is deleted.

    • long_lived boolean | null

      Re-use this chat channel for future interactions with a contact

    • sid string | null

      The unique string that identifies the resource

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

    • url string(uri) | null

      The absolute URL of the Flex Flow resource
POST /v1/FlexFlows 
curl \
 -X POST https://flex-api.twilio.com/v1/FlexFlows \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'ChannelType=web&ChatServiceSid=string&ContactIdentity=string&Enabled=true&FriendlyName=string&Integration.Channel=string&Integration.CreationOnMessage=true&Integration.FlowSid=string&Integration.Priority=42&Integration.RetryCount=42&Integration.Timeout=42&Integration.Url=https%3A%2F%2Fexample.com&Integration.WorkflowSid=string&Integration.WorkspaceSid=string&IntegrationType=studio&JanitorEnabled=true&LongLived=true'
Request example 
{
  "ChannelType": "web",
  "ChatServiceSid": "string",
  "ContactIdentity": "string",
  "Enabled": true,
  "FriendlyName": "string",
  "Integration.Channel": "string",
  "Integration.CreationOnMessage": true,
  "Integration.FlowSid": "string",
  "Integration.Priority": 42,
  "Integration.RetryCount": 42,
  "Integration.Timeout": 42,
  "Integration.Url": "https://example.com",
  "Integration.WorkflowSid": "string",
  "Integration.WorkspaceSid": "string",
  "IntegrationType": "studio",
  "JanitorEnabled": true,
  "LongLived": true
}
Request examples 
{
  "ChannelType": "web",
  "ChatServiceSid": "string",
  "ContactIdentity": "string",
  "Enabled": true,
  "FriendlyName": "string",
  "Integration.Channel": "string",
  "Integration.CreationOnMessage": true,
  "Integration.FlowSid": "string",
  "Integration.Priority": 42,
  "Integration.RetryCount": 42,
  "Integration.Timeout": 42,
  "Integration.Url": "https://example.com",
  "Integration.WorkflowSid": "string",
  "Integration.WorkspaceSid": "string",
  "IntegrationType": "studio",
  "JanitorEnabled": true,
  "LongLived": true
}
Response examples (201) 
{
  "account_sid": "string",
  "channel_type": "web",
  "chat_service_sid": "string",
  "contact_identity": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "enabled": true,
  "friendly_name": "string",
  "integration_type": "studio",
  "janitor_enabled": true,
  "long_lived": true,
  "sid": "string",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "channel_type": "web",
  "chat_service_sid": "string",
  "contact_identity": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "enabled": true,
  "friendly_name": "string",
  "integration_type": "studio",
  "janitor_enabled": true,
  "long_lived": true,
  "sid": "string",
  "url": "https://example.com"
}