Skip to content Skip to navigation Skip to topbar

Twilio Docs

Twilio Flex Developer Documentation Index

Getting Started

Building with Flex checklist Set up your Flex Instance Getting Started with React Plugin Development

Tutorials

Add Components to Flex UI Setting up an IVR with Studio

Flex Insights

Overview TaskRouter Data in Flex Insights Add Additional TaskRouter Data Label Data Enabling Dual-Channel Recordings Custom Media attached to Conversations Secure Playback of Recordings from Custom Storage Embedding Dashboards Dashboards Programmability Run Insights on a Custom Domain Workforce Management Real-Time Adherence HIPAA for Insights Historical Reporting

Insights API

General Usage Export Data Map Global Identifiers to Workspace Identifiers

Messaging

API Overview

Flex Flow Resource Manage Flex Flows Flex Chat Channel Resource

Architectural Overviews

Inbound Messages with Flex WebChat UI Integrate a Custom Chat Client with Flex Receive Inbound Messages from SMS, WhatsApp and Facebook Messenger Send Outbound Messages via SMS, WhatsApp and Other Channels

Messaging Limits FAQ and Troubleshooting

Flex Webchat 2.0

Overview Set up and use Webchat 2.0 Configuration Theming, Styling, and Branding Components Localization and UI templating (Webchat 2.0)Actions Cookies and the Web Storage API (Webchat 2.0)Using Pre-Engagement Form Data and Context (Webchat 2.0)Enable Chat Attachments (Webchat 2.0)Customizing Chat Attachment Behavior (Webchat 2.0)Building with Chat Attachments (Webchat 2.0)

Conversations

Getting Started Developer Overview

API Overview

Interactions API Interactions Resource Channels Subresource Interaction Channel Participants Invites Subresource WebChats Resource

Guides

Receive Inbound Messages with Flex Conversations Channels Send Outbound Messages with Flex Conversations Channels Park an Interaction Integrate a Custom Chat Client with Flex Integrate Webchat React App with Flex

File Attachments and API Limits FAQ and Troubleshooting

Flex Webchat 3.0 (Public Beta)

Webchat 3.0 overview Webchat 3.0 security Set up and use Webchat 3.0 Migrate to Webchat 3.0 Cookies and the Web Storage API Using Pre-Engagement Form Data and Context

Known Issues Best Practices

Voice

Overview Implement Click-to-Dial Administrator Guide: Dialpad Overview

Email

Building with Email in Twilio Flex Customize the Email in Flex UI Manage email conversations Email in Flex limitations

Flex UI and Plugins

Overview UI and Plugins Flex UI 2.0 Enhancements Flex UI Requirements Overview of Flex UI programmability options Override Flex UI 2.x.x themes, branding and styling Flex Plugin Library Use Twilio Paste with a Flex Plugin

Flex UI Components

Overview Work with Components and Props Add Components to Flex UI Create and Style Components Add Context to Components

Use UI Actions Use Redux with Flex Modify Flex UI Keyboard Shortcuts Work with Notifications Task Channel Definitions Create Custom Views and Routes Sounds and Audio Team View Filters Real-Time Queues View Programmability Web Accessibility Developer Guide to Troubleshooting the Flex UI Error Handling and Debugging Downgrade to Flex UI 1.x.x

Flex UI 1.x.x

1.0 Overview Flex Manager Flex UI Configuration Localization and UI Templating Theming, Branding, and Styling Flex UI Icons Flex UI Components Actions Framework Notifications Framework Task Channel Definitions Solutions Library (Flex UI 1.x.x)

Migrate from Flex UI 1.x.x to 2.x.x

Build a Flex Plugin

Make HTTP Requests Debugging a Flex Plugin React versions Environment Variables in Flex Plugins Sample Solutions

Manage Plugins

Custom Plugins Dashboard Keep Plugins Up-To-Date

Plugins CLI

Overview Install Flex Plugins CLI Upgrade Flex Plugins CLI Migrate Legacy Plugins to the CLI Common Use Cases Run Multiple Plugins Locally Validate, Deploy, and Release Archive Plugins and Configurations Plugins CLI Reference Plugins CLI release notes

Plugins API

Overview Releasing Flex plugins with the Plugins API Rolling Back a Release Plugin Resource Plugin Version Resource Plugin Configuration Resource Plugin Release Resource

Configuration

Overview The appConfig.js object Flex Configuration REST API Known issue for self-hosted Flex

Agent Routing with TaskRouter Agent Copilot: Use a webhook to store wrap-up notes (Public Beta)

Release Notes

How We Release Flex Flex UI Release Notes for 2.x.x Flex UI Release Notes for v1.x.x Flex WebChat UI Release Notes

Administrator Guide End User Guide

Messaging
Voice
Serverless
Flex
Studio
All docs...

SDKs
Help

Log in
Sign up

Rate this page:

12345

On this page

Channel Properties
Create a Channel resource

Request body parameters
Fetch a Channel resource
Path parameters
Read multiple Channel resources
Query parameters
Delete a Channel resource
Path parameters

Channel Properties

Create a Channel resource

Request body parameters

Fetch a Channel resource

Path parameters

Read multiple Channel resources

Query parameters

Delete a Channel resource

Path parameters

Flex Chat Channel Resource

(information)

Info

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.

Flex Chat Channels allow agents to communicate with your customers across multiple channels like Webchat, SMS, and WhatsApp through a single chat interface. You can create a chat channel in Flex whenever you want to initiate a new communication flow between an agent and a customer. The Flex Chat Channel is an implementation of the Chat Channel Resource orchestrated for Flex.

Channel Properties

Property nameTypePIIDescription

account_sidSID<AC>

The SID of the Account that created the Channel resource and owns this Workflow.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

flex_flow_sidSID<FO>

The SID of the Flex Flow.

Pattern: ^FO[0-9a-fA-F]{32}$Min length: 34Max length: 34

sidSID<CH>

The unique string that we created to identify the Channel resource.

Pattern: ^CH[0-9a-fA-F]{32}$Min length: 34Max length: 34

user_sidSID<US>

The SID of the chat user.

Pattern: ^US[0-9a-fA-F]{32}$Min length: 34Max length: 34

task_sidSID<WT>

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

Pattern: ^WT[0-9a-fA-F]{32}$Min length: 34Max length: 34

urlstring<uri>

The absolute URL of the Flex chat channel resource.

date_createdstring<date-time>

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

date_updatedstring<date-time>

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

Create a Channel resource

POST https://flex.twilio.com/v1/Channels

Request body parameters

Property nameTypeRequiredPIIDescription

FlexFlowSidSID<FO>required

The SID of the Flex Flow.

Pattern: ^FO[0-9a-fA-F]{32}$Min length: 34Max length: 34

Identitystringrequired

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

ChatUserFriendlyNamestringrequired

The chat participant's friendly name.

ChatFriendlyNamestringrequired

The chat channel's friendly name.

TargetstringOptional

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

ChatUniqueNamestringOptional

The chat channel's unique name.

PreEngagementDatastringOptional

The pre-engagement data.

TaskSidSID<WT>Optional

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

Pattern: ^WT[0-9a-fA-F]{32}$Min length: 34Max length: 34

TaskAttributesstringOptional

The Task attributes to be added for the TaskRouter Task.

LongLivedbooleanOptional

Whether to create the channel as long-lived.

Create a Channel

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_21// Download the helper library from https://www.twilio.com/docs/node/install
_21const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_21
_21// Find your Account SID and Auth Token at twilio.com/console
_21// and set the environment variables. See http://twil.io/secure
_21const accountSid = process.env.TWILIO_ACCOUNT_SID;
_21const authToken = process.env.TWILIO_AUTH_TOKEN;
_21const client = twilio(accountSid, authToken);
_21
_21async function createChannel() {
_21  const channel = await client.flexApi.v1.channel.create({
_21    chatFriendlyName: "ChatFriendlyName",
_21    chatUserFriendlyName: "ChatUserFriendlyName",
_21    flexFlowSid: "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_21    identity: "Identity",
_21  });
_21
_21  console.log(channel.accountSid);
_21}
_21
_21createChannel();

Output


_10{
_10  "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "date_created": "2016-08-01T22:10:40Z",
_10  "date_updated": "2016-08-01T22:10:40Z",
_10  "url": "https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_10}

Fetch a Channel resource

GET https://flex.twilio.com/v1/Channels/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<CH>required

The SID of the Flex chat channel resource to fetch.

Pattern: ^CH[0-9a-fA-F]{32}$Min length: 34Max length: 34

Fetch a Channel

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18
_18async function fetchChannel() {
_18  const channel = await client.flexApi.v1
_18    .channel("CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18    .fetch();
_18
_18  console.log(channel.accountSid);
_18}
_18
_18fetchChannel();

Output


_10{
_10  "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "date_created": "2016-08-01T22:10:40Z",
_10  "date_updated": "2016-08-01T22:10:40Z",
_10  "url": "https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_10}

Read multiple Channel resources

GET https://flex.twilio.com/v1/Channels

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeintegerOptional

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

PageintegerOptional

The page index. This value is simply for client state.

Minimum: 0

PageTokenstringOptional

The page token. This is provided by the API.

List multiple Channels

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_16// Download the helper library from https://www.twilio.com/docs/node/install
_16const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_16
_16// Find your Account SID and Auth Token at twilio.com/console
_16// and set the environment variables. See http://twil.io/secure
_16const accountSid = process.env.TWILIO_ACCOUNT_SID;
_16const authToken = process.env.TWILIO_AUTH_TOKEN;
_16const client = twilio(accountSid, authToken);
_16
_16async function listChannel() {
_16  const channels = await client.flexApi.v1.channel.list({ limit: 20 });
_16
_16  channels.forEach((c) => console.log(c.accountSid));
_16}
_16
_16listChannel();

Output


_23{
_23  "meta": {
_23    "page": 0,
_23    "page_size": 50,
_23    "first_page_url": "https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0",
_23    "previous_page_url": null,
_23    "url": "https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0",
_23    "next_page_url": null,
_23    "key": "flex_chat_channels"
_23  },
_23  "flex_chat_channels": [
_23    {
_23      "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_23      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_23      "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_23      "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_23      "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_23      "date_created": "2016-08-01T22:10:40Z",
_23      "date_updated": "2016-08-01T22:10:40Z",
_23      "url": "https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_23    }
_23  ]
_23}

Delete a Channel resource

DELETE https://flex.twilio.com/v1/Channels/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<CH>required

The SID of the Flex chat channel resource to delete.

Pattern: ^CH[0-9a-fA-F]{32}$Min length: 34Max length: 34

Delete a Channel

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_16// Download the helper library from https://www.twilio.com/docs/node/install
_16const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_16
_16// Find your Account SID and Auth Token at twilio.com/console
_16// and set the environment variables. See http://twil.io/secure
_16const accountSid = process.env.TWILIO_ACCOUNT_SID;
_16const authToken = process.env.TWILIO_AUTH_TOKEN;
_16const client = twilio(accountSid, authToken);
_16
_16async function deleteChannel() {
_16  await client.flexApi.v1
_16    .channel("CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_16    .remove();
_16}
_16
_16deleteChannel();

Rate this page:

12345

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

Terms of service

Copyright © 2024 Twilio Inc.