Menu

Expand
Rate this page:

Flex Chat Channel Resource

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
sid<AC> Not PII

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

flex_flow_sid
sid<FO> Not PII

The SID of the Flex Flow.

sid
sid<CH> Not PII

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

user_sid
sid<US> Not PII

The SID of the chat user.

task_sid
sid<WT> Not PII

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

url
url Not PII

The absolute URL of the Flex chat channel resource.

date_created
date_time<iso8601> Not PII

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

date_updated
date_time<iso8601> Not PII

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-api.twilio.com/v1/Channels
Parameters
Parameters in REST API format
flex_flow_sid
Required
post sid<FO> Not PII

The SID of the Flex Flow.

identity
Required
post string PII MTL: 30 DAYS

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

chat_user_friendly_name
Required
post string PII MTL: 30 DAYS

The chat participant's friendly name.

chat_friendly_name
Required
post string PII MTL: 30 DAYS

The chat channel's friendly name.

target
Optional
post string PII MTL: 30 DAYS

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

chat_unique_name
Optional
post string PII MTL: 30 DAYS

The chat channel's unique name.

pre_engagement_data
Optional
post string PII MTL: 30 DAYS

The pre-engagement data.

task_sid
Optional
post sid<WT> Not PII

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

task_attributes
Optional
post string PII MTL: 30 DAYS

The Task attributes to be added for the TaskRouter Task.

long_lived
Optional
post boolean Not PII

Whether to create the channel as long-lived.

Example 1
        
        
        

        Fetch a Channel resource

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

        The SID of the Flex chat channel resource to fetch.

        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
                    Parameters in REST API format
                    sid
                    Path
                    delete sid<CH> Not PII

                    The SID of the Flex chat channel resource to delete.

                    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 by visiting Twilio's Community Forums or browsing the Twilio tag on Stack Overflow.

                                
                                
                                

                                Thank you for your feedback!

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

                                Sending your feedback...
                                🎉 Thank you for your feedback!
                                Something went wrong. Please try again.

                                Thanks for your feedback!

                                Refer us and get $10 in 3 simple steps!

                                Step 1

                                Get link

                                Get a free personal referral link here

                                Step 2

                                Give $10

                                Your user signs up and upgrade using link

                                Step 3

                                Get $10

                                1,250 free SMSes
                                OR 1,000 free voice mins
                                OR 12,000 chats
                                OR more