Flex Chat Channel Resource
This guide is for Flex UI 1.x and channels that use Programmable Chat and Proxy. If you are using Flex UI 2.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
| Resource Properties in REST API format | |
|---|---|
account_sid
|
The SID of the Account that created the Channel resource and owns this Workflow. |
flex_flow_sid
|
The SID of the Flex Flow. |
sid
|
The unique string that we created to identify the Channel resource. |
user_sid
|
The SID of the chat user. |
task_sid
|
The SID of the TaskRouter Task. Only valid when integration type is |
url
|
The absolute URL of the Flex chat channel resource. |
date_created
|
The date and time in GMT when the Flex chat channel was created specified in ISO 8601 format. |
date_updated
|
The date and time in GMT when the Flex chat channel was last updated specified in ISO 8601 format. |
Create a Channel resource
https://flex-api.twilio.com/v1/Channels
Parameters
| Parameters in REST API format | |
|---|---|
flex_flow_sid
Required
|
The SID of the Flex Flow. |
identity
Required
|
The |
chat_user_friendly_name
Required
|
The chat participant's friendly name. |
chat_friendly_name
Required
|
The chat channel's friendly name. |
target
Optional
|
The Target Contact Identity, for example the phone number of an SMS. |
chat_unique_name
Optional
|
The chat channel's unique name. |
pre_engagement_data
Optional
|
The pre-engagement data. |
task_sid
Optional
|
The SID of the TaskRouter Task. Only valid when integration type is |
task_attributes
Optional
|
The Task attributes to be added for the TaskRouter Task. |
long_lived
Optional
|
Whether to create the channel as long-lived. |
Example 1
Fetch a Channel resource
https://flex-api.twilio.com/v1/Channels/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The SID of the Flex chat channel resource to fetch. |
Example 1
Read multiple Channel resources
https://flex-api.twilio.com/v1/Channels
Example 1
Delete a Channel resource
https://flex-api.twilio.com/v1/Channels/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The SID of the Flex chat channel resource to delete. |
Example 1
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.
