Channels Subresource
Flex Conversations requires Flex UI 2.0. If you are on Flex UI 1.x, please refer to Messaging in Flex pages.
The Interactions Channels subresource represents the communication channel associated with the interaction. An interaction channel may have multiple tasks associated with it but can only have one Twilio Conversation associated.
This subresource allows you to update the status of a channel but does not support creating a channel directly. Use the Interactions resource to create a channel.
When a channel is created through the Interactions resource, a task is created and is immediately routed to Flex using the supplied TaskRouter workspace.
InteractionChannel properties
| Resource Properties in REST API format | |
|---|---|
sid
|
The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO. |
interaction_sid
|
The unique string created by Twilio to identify an Interaction resource, prefixed with KD. |
type
|
The Interaction Channel's type. Can be: |
status
|
The status of this channel. |
error_code
|
The Twilio error code for a failed channel. |
error_message
|
The error message for a failed channel. |
url
|
|
links
|
|
| Parameter | Sub-fields | Description |
| Status [required] |
Indicates the interaction channel status. When a channel is set to closed, all tasks are put in "wrapping" state by default unless the Routing status is set to "closed" in which case the tasks will be "completed". Value: closed |
|
| Routing [optional] | The state of associated tasks. If not specified, all tasks will be set to “wrapping”. | |
| status |
Value: closed If closed is specified, all associated tasks will be set to “completed”. |
Fetch a Channel
https://flex-api.twilio.com/v1/Interactions/{InteractionSid}/Channels/{Sid}
This lets you retrieve a single Channel instance.
Parameters
| Parameters in REST API format | |
|---|---|
interaction_sid
Path
|
The unique string created by Twilio to identify an Interaction resource, prefixed with KD. |
sid
Path
|
The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO. |
Example 1
List Channels
GET /Interactions/<interaction_sid>/ChannelsSince only one Channel is supported in the private beta release, only one Channel will be returned.
Response Object
| Parameter | Description |
| sid |
Unique identifier for the interaction channel |
| interaction_sid |
Unique identifier for the interaction |
| The channel type specified when the interaction was created. Please refer to the Interactions Properties table for possible values. | |
| links | A JSON object linking to the interaction channel's associated participants and invites |
Example 2
A channel is deleted after 180 days of inactivity regardless of state. Retrieving the channel after 180 days from deletion returns a 404 Not Found. Note that the initial TTL (Time to Live) period resets every time there is an update to the channel (e.g. adding and removing a participant, or updating the channel status).
Close an Interaction Channel
https://flex-api.twilio.com/v1/Interactions/{InteractionSid}/Channels/{Sid}
This subresource lets a developer close a channel in an interaction. When you close a channel, all tasks and reservations for all agents on the channel will be set to wrapup state. If you wish to complete the tasks, you can supply the optional routing status parameter with the value closed.
Furthermore, when you set the channel status to closed, the underlying media channel will also be closed. This changes the channel to "read-only" regardless of the routing status.
The following table illustrates the media channel and task states for a given Channel and Routing status.
| Channel status | Routing status | Resulting task state | Resulting conversation state |
| closed | Not specified | wrapping | closed |
| closed | closed | completed | closed |
In some cases, it is desired to keep the channel open but have the agents complete their tasks. To achieve this, use the Channel Participant subresource to modify the status of the participants rather than the channel. Note however that you will need to add more logic to ensure you invite the same or a new agent on the next incoming message.
Parameters
| Parameters in REST API format | |
|---|---|
interaction_sid
Path
|
The unique string created by Twilio to identify an Interaction resource, prefixed with KD. |
sid
Path
|
The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO. |
status
Required
|
Required. Indicates the Interaction channel's status. When a channel is set to |
routing
Optional
|
Optional. The state of associated tasks. If not specified, all tasks will be set to |
Example 1
Example 2
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.
