Create channel

POST /v1/Channels

Flex chat channels

Body

  • ChatFriendlyName string Required

    The chat channel's friendly name.

  • ChatUniqueName string

    The chat channel's unique name.

  • ChatUserFriendlyName string Required

    The chat participant's friendly name.

  • FlexFlowSid string Required

    The SID of the Flex Flow.

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

  • Identity string Required

    The identity value that uniquely identifies the new resource's chat User.

  • LongLived boolean

    Whether to create the channel as long-lived.

  • PreEngagementData string

    The pre-engagement data.

  • Target string

    The Target Contact Identity, for example the phone number of an SMS.

  • TaskAttributes string

    The Task attributes to be added for the TaskRouter Task.

  • TaskSid string

    The SID of the TaskRouter Task. Only valid when integration type is task. null for integration types studio & external

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

Responses

  • 201

    Created

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

      The SID of the Account that created the 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 ISO 8601 date and time in GMT when the Flex chat channel was created

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the Flex chat channel was last updated

    • flex_flow_sid string | null

      The SID of the Flex Flow

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

    • sid string | null

      The unique string that identifies the resource

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

    • task_sid string | null

      The SID of the TaskRouter Task

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

    • url string(uri) | null

      The absolute URL of the Flex chat channel resource

    • user_sid string | null

      The SID of the chat user

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^US[0-9a-fA-F]{32}$.
POST /v1/Channels 
curl \
 -X POST https://flex-api.twilio.com/v1/Channels \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'ChatFriendlyName=string&ChatUniqueName=string&ChatUserFriendlyName=string&FlexFlowSid=string&Identity=string&LongLived=true&PreEngagementData=string&Target=string&TaskAttributes=string&TaskSid=string'
Request example 
{
  "ChatFriendlyName": "string",
  "ChatUniqueName": "string",
  "ChatUserFriendlyName": "string",
  "FlexFlowSid": "string",
  "Identity": "string",
  "LongLived": true,
  "PreEngagementData": "string",
  "Target": "string",
  "TaskAttributes": "string",
  "TaskSid": "string"
}
Request examples 
{
  "ChatFriendlyName": "string",
  "ChatUniqueName": "string",
  "ChatUserFriendlyName": "string",
  "FlexFlowSid": "string",
  "Identity": "string",
  "LongLived": true,
  "PreEngagementData": "string",
  "Target": "string",
  "TaskAttributes": "string",
  "TaskSid": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "flex_flow_sid": "string",
  "sid": "string",
  "task_sid": "string",
  "url": "https://example.com",
  "user_sid": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "flex_flow_sid": "string",
  "sid": "string",
  "task_sid": "string",
  "url": "https://example.com",
  "user_sid": "string"
}