Interaction Channel Participants
Info
Flex Conversations requires Flex UI 2.0.x. If you are on Flex UI 1.x.x, refer to the 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.
Resource properties
sid
type: SID<UT>
The unique string created by Twilio to identify an Interaction Channel Participant resource.
Pattern:
^UT[0-9a-fA-F]{32}$
type
type: enum<string>
Participant type. Can be: agent
, customer
, supervisor
, external
, unknown
Possible values:
supervisor
customer
external
agent
unknown
interaction_sid
type: SID<KD>
The Interaction Sid for this channel.
Pattern:
^KD[0-9a-fA-F]{32}$
channel_sid
type: SID<UO>
The Channel Sid for this Participant.
Pattern:
^UO[0-9a-fA-F]{32}$
routing_properties
type: object
The Participant's routing properties.
GET https://flex-api.twilio.com/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants
URI parameters
InteractionSid
type: SID<KD>
The Interaction Sid for this channel.
Pattern:
^KD[0-9a-fA-F]{32}$
ChannelSid
type: SID<UO>
The Channel Sid for this Participant.
Pattern:
^UO[0-9a-fA-F]{32}$
PageSize
type: integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
type: integer
The page index. This value is simply for client state.
PageToken
type: string
The page token. This is provided by the API.
_12// Download the helper library from https://www.twilio.com/docs/node/install
_12// Find your Account SID and Auth Token at twilio.com/console
_12// and set the environment variables. See http://twil.io/secure
_12const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12const authToken = process.env.TWILIO_AUTH_TOKEN;
_12const client = require('twilio')(accountSid, authToken);
_12client.flexApi.v1.interaction('KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .channels('UOXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .then(participants => participants.forEach(p => console.log(p.sid)));
_33 "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
_33 "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
_33 "interaction_sid": "KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_33 "routing_properties": null,
_33 "url": "https://flex-api.twilio.com/v1/Interactions/KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1"
_33 "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2",
_33 "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
_33 "interaction_sid": "KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_33 "routing_properties": {
_33 "task_sid": "WTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_33 "worker_sid": "WKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_33 "reservation_sid": "WRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_33 "url": "https://flex-api.twilio.com/v1/Interactions/KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2"
_33 "first_page_url": "https://flex-api.twilio.com/v1/Interactions/KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants?PageSize=50&Page=0",
_33 "previous_page_url": "https://flex-api.twilio.com/v1/Interactions/KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants?PageSize=50&Page=0",
_33 "url": "https://flex-api.twilio.com/v1/Interactions/KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants?PageSize=50&Page=0",
_33 "next_page_url": "https://flex-api.twilio.com/v1/Interactions/KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants?PageSize=50&Page=1",
_33 "key": "participants"
POST https://flex-api.twilio.com/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid}
URI parameters
InteractionSid
type: SID<KD>
The Interaction Sid for this channel.
Pattern:
^KD[0-9a-fA-F]{32}$
ChannelSid
type: SID<UO>
The Channel Sid for this Participant.
Pattern:
^UO[0-9a-fA-F]{32}$
Sid
type: SID<UT>
The unique string created by Twilio to identify an Interaction Channel resource.
Pattern:
^UT[0-9a-fA-F]{32}$
Request body parameters
Status
type: enum<string>Required
The Participant's status. Can be: closed
or wrapup
. Participant must be an agent.
Possible values:
closed
wrapup
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.
_12// Download the helper library from https://www.twilio.com/docs/node/install
_12// Find your Account SID and Auth Token at twilio.com/console
_12// and set the environment variables. See http://twil.io/secure
_12const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12const authToken = process.env.TWILIO_AUTH_TOKEN;
_12const client = require('twilio')(accountSid, authToken);
_12client.flexApi.v1.interaction('KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .channels('UOXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .participants('UTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .update({status: 'wrapup'})
_12 .then(interaction_channel_participant => console.log(interaction_channel_participant.sid));
_12 "sid": "UTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "channel_sid": "UOXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "interaction_sid": "KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "routing_properties": {
_12 "task_sid": "WTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "worker_sid": "WKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "reservation_sid": "WRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_12 "url": "https://flex-api.twilio.com/v1/Interactions/KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1"
This changes the agent reservation status to 'completed'.
_12// Download the helper library from https://www.twilio.com/docs/node/install
_12// Find your Account SID and Auth Token at twilio.com/console
_12// and set the environment variables. See http://twil.io/secure
_12const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12const authToken = process.env.TWILIO_AUTH_TOKEN;
_12const client = require('twilio')(accountSid, authToken);
_12client.flexApi.v1.interaction('KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .channels('UOXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .participants('UTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .update({status: 'closed'})
_12 .then(interaction_channel_participant => console.log(interaction_channel_participant.sid));
_12 "sid": "UTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "channel_sid": "UOXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "interaction_sid": "KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "routing_properties": {
_12 "task_sid": "WTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "worker_sid": "WKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "reservation_sid": "WRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_12 "url": "https://flex-api.twilio.com/v1/Interactions/KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1"