Skip to contentSkip to navigationSkip to topbar
Twilio Docs
Rate this page:
On this page

Interaction Channel Participants

(information)

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.

InteractionChannelParticipant Properties

interactionchannelparticipant-properties page anchor
Resource properties
sidtype: SID<UT>
Not PII

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

Pattern:
^UT[0-9a-fA-F]{32}$
Min length:
34
Max length:
34
typetype: enum<string>
Not PII

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

Possible values:
supervisorcustomerexternalagentunknown
interaction_sidtype: SID<KD>
Not PII

The Interaction Sid for this channel.

Pattern:
^KD[0-9a-fA-F]{32}$
Min length:
34
Max length:
34
channel_sidtype: SID<UO>
Not PII

The Channel Sid for this Participant.

Pattern:
^UO[0-9a-fA-F]{32}$
Min length:
34
Max length:
34
urltype: string<uri>
Not PII
routing_propertiestype: object
Not PII

The Participant's routing properties.

Fetch Channel Participants

fetch-channel-participants page anchor
GET https://flex-api.twilio.com/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants

Parameters

list-parameters page anchor
URI parameters
InteractionSidtype: SID<KD>
Path ParameterNot PII

The Interaction Sid for this channel.

Pattern:
^KD[0-9a-fA-F]{32}$
Min length:
34
Max length:
34
ChannelSidtype: SID<UO>
Path ParameterNot PII

The Channel Sid for this Participant.

Pattern:
^UO[0-9a-fA-F]{32}$
Min length:
34
Max length:
34
PageSizetype: integer
Query ParameterNot PII

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum:
1
Pagetype: integer
Query ParameterNot PII

The page index. This value is simply for client state.

Minimum:
0
PageTokentype: string
Query ParameterNot PII

The page token. This is provided by the API.

Fetch Channel Participants

fetch-channel-participants-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_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
_12
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12
const authToken = process.env.TWILIO_AUTH_TOKEN;
_12
const client = require('twilio')(accountSid, authToken);
_12
_12
client.flexApi.v1.interaction('KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12
.channels('UOXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12
.participants
_12
.list({limit: 20})
_12
.then(participants => participants.forEach(p => console.log(p.sid)));

Output

_33
{
_33
"participants": [
_33
{
_33
"sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
_33
"channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
_33
"interaction_sid": "KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_33
"type": "customer",
_33
"routing_properties": null,
_33
"url": "https://flex-api.twilio.com/v1/Interactions/KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1"
_33
},
_33
{
_33
"sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2",
_33
"channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
_33
"interaction_sid": "KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_33
"type": "agent",
_33
"routing_properties": {
_33
"task_sid": "WTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_33
"worker_sid": "WKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_33
"reservation_sid": "WRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_33
},
_33
"url": "https://flex-api.twilio.com/v1/Interactions/KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2"
_33
}
_33
],
_33
"meta": {
_33
"page": 0,
_33
"page_size": 50,
_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"
_33
}
_33
}

Modify a Channel Participant

modify-a-channel-participant page anchor
POST https://flex-api.twilio.com/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid}

Parameters

update-parameters page anchor
URI parameters
InteractionSidtype: SID<KD>
Path ParameterNot PII

The Interaction Sid for this channel.

Pattern:
^KD[0-9a-fA-F]{32}$
Min length:
34
Max length:
34
ChannelSidtype: SID<UO>
Path ParameterNot PII

The Channel Sid for this Participant.

Pattern:
^UO[0-9a-fA-F]{32}$
Min length:
34
Max length:
34
Sidtype: SID<UT>
Path ParameterNot PII

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

Pattern:
^UT[0-9a-fA-F]{32}$
Min length:
34
Max length:
34
Request body parameters
Statustype: enum<string>Required
Not PII

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

Possible values:
closedwrapup

Wrap up agent reservation

wrap-up-agent-reservation page anchor

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.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_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
_12
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12
const authToken = process.env.TWILIO_AUTH_TOKEN;
_12
const client = require('twilio')(accountSid, authToken);
_12
_12
client.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));

Output

_12
{
_12
"sid": "UTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"channel_sid": "UOXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"interaction_sid": "KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"type": "agent",
_12
"routing_properties": {
_12
"task_sid": "WTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"worker_sid": "WKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"reservation_sid": "WRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_12
},
_12
"url": "https://flex-api.twilio.com/v1/Interactions/KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1"
_12
}

Complete a single agent reservation

complete-a-single-agent-reservation page anchor

This changes the agent reservation status to 'completed'.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_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
_12
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12
const authToken = process.env.TWILIO_AUTH_TOKEN;
_12
const client = require('twilio')(accountSid, authToken);
_12
_12
client.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));

Output

_12
{
_12
"sid": "UTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"channel_sid": "UOXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"interaction_sid": "KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"type": "agent",
_12
"routing_properties": {
_12
"task_sid": "WTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"worker_sid": "WKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"reservation_sid": "WRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_12
},
_12
"url": "https://flex-api.twilio.com/v1/Interactions/KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1"
_12
}

Rate this page: