Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Flex Chat Channels

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.

Channel properties

Property

Description

account_sid The SID of the Account that created the resource.
flex_flow_sid The SID of the Flex Flow associated with the Flex Channel.
sid The unique string that we use to identify the Flex Channel resource.
user_sid The SID of the Chat User associated with the Flex Channel
task_sid The SID of the Task associated with the Flex Channel.
url The absolute URL of the Flex Channel resource.
Names in PHP format
accountSid
sid<AC> Not PII

The ID of the account that owns this Workflow

flexFlowSid
sid<FO> Not PII

The unique ID of the FlexFlow

sid
sid<CH> Not PII

The unique SID identifier of the Flex Chat Channel

userSid
sid<US> Not PII

The unique SID identifier of the chat user

taskSid
sid<WT> Not PII

The unique SID identifier of the Taskrouter task

url
url Not PII

dateCreated
date_time<iso8601> Not PII

The time the Flex Chat Channel was created, given as GMT in ISO 8601 format.

dateUpdated
date_time<iso8601> Not PII

The time the Flex Chat Channel was last updated, given as GMT in ISO 8601 format.

Create a Channel resource

post
https://flex-api.twilio.com/v1/Channels
Parameters
Names in None format
flex_flow_sid
Required
post sid<FO> Not PII

The unique ID of the FlexFlow

identity
Required
post string PII MTL: 30 DAYS

Chat User identity

chat_user_friendly_name
Required
post string PII MTL: 30 DAYS

Customer friendly name (chat participant)

chat_friendly_name
Required
post string PII MTL: 30 DAYS

Chat channel friendly name

target
Optional
post string PII MTL: 30 DAYS

Target Contact Identity, for example phone number for SMS

chat_unique_name
Optional
post string PII MTL: 30 DAYS

Chat channel unique name

pre_engagement_data
Optional
post string PII MTL: 30 DAYS

Pre-engagement data

task_sid
Optional
post sid<WT> Not PII

The unique SID identifier of the Taskrouter task

task_attributes
Optional
post string PII MTL: 30 DAYS

Task attributes to be added for the TaskRouter Task

long_lived
Optional
post boolean Not PII

Boolean flag determining whether channel is created as long lived or not

Example 1
        
        
        
        

        Fetch a Channel resource

        get
        https://flex-api.twilio.com/v1/Channels/{Sid}
        Parameters
        Names in None format
        sid
        Required
        get sid<CH> Not PII

        The unique SID identifier of the Flex Chat Channel

        Example 1
              
              
              
              

              Read multiple Channel resources

              get
              https://flex-api.twilio.com/v1/Channels
              Example 1
                    
                    
                    
                    

                    Delete a Channel resource

                    delete
                    https://flex-api.twilio.com/v1/Channels/{Sid}
                    Parameters
                    Names in None format
                    sid
                    Required
                    delete sid<CH> Not PII

                    The unique SID identifier of the Flex Chat Channel

                    Example 1
                          
                          
                          
                          
                          Rate this page:

                          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 browsing the Twilio tag on Stack Overflow.