POST /v1/Channels
Account sid auth token

Flex chat channels

application/x-www-form-urlencoded

Body

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

  • ChatUserFriendlyName string Required

    The chat participant's friendly name.

  • ChatFriendlyName string Required

    The chat channel's friendly name.

  • Target string

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

  • ChatUniqueName string

    The chat channel's unique name.

  • PreEngagementData string

    The pre-engagement data.

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

  • TaskAttributes string

    The Task attributes to be added for the TaskRouter Task.

  • LongLived boolean

    Whether to create the channel as long-lived.

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

    • 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 we created to identify the Channel resource.

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

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

    • task_sid string | null

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

    • url string(uri) | null

      The absolute URL of the Flex chat channel resource.

    • date_created string(date-time) | null

      The date and time in GMT when the Flex chat channel was created specified in ISO 8601 format.

    • date_updated string(date-time) | null

      The date and time in GMT when the Flex chat channel was last updated specified in ISO 8601 format.
POST /v1/Channels 
curl \
 --request POST 'https://flex-api.twilio.com/v1/Channels' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'FlexFlowSid=FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Target=def&Identity=abc&ChatUserFriendlyName=friendly2&ChatFriendlyName=friendly1&ChatUniqueName=unique&PreEngagementData=%7B%7D&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskAttributes=%7B%7D&LongLived=true'
Request example 
{"FlexFlowSid" => "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "Target" => "def", "Identity" => "abc", "ChatUserFriendlyName" => "friendly2", "ChatFriendlyName" => "friendly1", "ChatUniqueName" => "unique", "PreEngagementData" => "{}", "TaskSid" => "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "TaskAttributes" => "{}", "LongLived" => true}
Response examples (201) 
{
  "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2016-08-01T22:10:40Z",
  "date_updated": "2016-08-01T22:10:40Z",
  "url": "https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}