Invites Subresource
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 Invite subresource allows you to add an agent as a new participant to an existing interaction channel.
/Interactions/<interaction_sid>/Channels/<channel_sid>/Invites
Use this endpoint to:
- add an agent to an ongoing interaction,
- to find an agent that should be added by evaluating a TaskRouter workflow, or
- to send an interaction to a queue.
The invite creates a new task for the existing interaction which will result in reservations offered to the agent(s). Note the example JSON response on this page is not representative of the actual API response. See example response on "Park an Interaction".
Remember to handle certain terminal TaskRouter events according to your application's needs, as conversations may stay orphaned with an open state.
See Conversations Best Practices for details.
Interaction Channel Invite properties
| Parameter | Sub-field | Description | |
|
Routing [required] |
A JSON Object representing the routing rules for the Interaction Channel. See Outbound SMS Example for an example Routing object. The Interactions resource uses TaskRouter for all routing functionality. |
||
|
properties [required] |
Fields needed to create a task: workspace_sid [required] The TaskRouter Workspace SID which starts with WS. workflow_sid [optional] The Workflow SID prefixed by WW. Optional if there’s only one workflow defined otherwise it’s mandatory queue_sid [required for agent-initiated], the Task router Queue SID prefixed by WQ. worker_sid [required for agent-initiated] task_channel_sid [optional] task_channel_unique_name [optional] attributes [optional] : The task attributes. priority [optional]: The priority of the task in the queue. timeout [optional]: The task/reservation timeout interval in seconds.
|
||
| Resource Properties in REST API format | |
|---|---|
sid
|
The unique string created by Twilio to identify an Interaction Channel Invite resource. |
interaction_sid
|
The Interaction SID for this Channel. |
channel_sid
|
The Channel SID for this Invite. |
routing
|
A JSON object representing the routing rules for the Interaction Channel. See Outbound SMS Example for an example Routing object. The Interactions resource uses TaskRouter for all routing functionality. All attributes in the Routing object on your Interaction request body are added “as is” to the task. For a list of known attributes consumed by the Flex UI and/or Flex Insights, see Known Task Attributes. |
url
|
|
Create an Interaction Channel Invite
https://flex-api.twilio.com/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Invites
Parameters
| Parameters in REST API format | |
|---|---|
interaction_sid
Path
|
The Interaction SID for this Channel. |
channel_sid
Path
|
The Channel SID for this Invite. |
routing
Required
|
The Interaction's routing logic. |
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.
