Menu

Expand
Rate this page:

Interaction Channel Participants

This Twilio product is currently available as a Beta release. Some features are not yet implemented and others may be changed before the product is declared as Generally Available. Use of this Beta release is subject to the relevant terms of the applicable license agreement. Beta products are not covered by a Twilio SLA. Learn more about beta product support.

Flex Conversations requires Flex UI 2.0. If you are on Flex UI 1.x, please refer to Messaging in Flex pages.

The Interaction Channel Participant subresource represents the actors communicating in an interaction channel. Typically, a channel will include people like agents, customers, and supervisors.

InteractionChannelParticipant properties

Resource Properties in REST API format
sid
sid<UT> Not PII

The unique string created by Twilio to identify an Interaction Channel Participant resource.

type
enum:type Not PII

Participant type. Can be: agent, customer, supervisor, external, unknown

interaction_sid
sid<KD> Not PII

The Interaction Sid for this channel.

channel_sid
sid<UO> Not PII

The Channel Sid for this Participant.

url
url Not PII

Fetch Channel Participants

get
https://flex-api.twilio.com/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants
Parameters
Parameters in REST API format
interaction_sid
Path
get sid<KD> Not PII

The Interaction Sid for this channel.

channel_sid
Path
get sid<UO> Not PII

The Channel Sid for this Participant.

Example 1
        
        
        

        Modify a Channel Participant

        post
        https://flex-api.twilio.com/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid}
        Parameters
        Parameters in REST API format
        interaction_sid
        Path
        post sid<KD> Not PII

        The Interaction Sid for this channel.

        channel_sid
        Path
        post sid<UO> Not PII

        The Channel Sid for this Participant.

        sid
        Path
        post sid<UO> Not PII

        The unique string created by Twilio to identify an Interaction Channel resource.

        status
        Required
        post ienum:status Not PII

        The Participant's status. Can be: closed or wrapup. Participant must be an agent.

        Example 1
              
              
              
              Put an agent's reservation status to "wrapup". This only applies to agents and the example request does not remove the agent from the channel.

              Wrap up agent reservation

              Put an agent's reservation status to "wrapup". This only applies to agents and the example request does not remove the agent from the channel.
              Example 2
                    
                    
                    
                    This changes the agent reservation status to "completed".

                    Complete a single agent reservation

                    This changes the agent reservation status to "completed".
                    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 Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

                          
                          
                          

                          Thank you for your feedback!

                          Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

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

                          Thanks for your feedback!

                          thanks-feedback-gif