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

Property nameTypePIIDescription

sidSID<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: 34Max length: 34

typeenum<string>

Not PII

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

Possible values:

supervisorcustomerexternalagentunknown

interaction_sidSID<KD>

Not PII

The Interaction Sid for this channel.

Pattern: ^KD[0-9a-fA-F]{32}$Min length: 34Max length: 34

channel_sidSID<UO>

Not PII

The Channel Sid for this Participant.

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

urlstring<uri>

Not PII

routing_propertiesobject

Not PII

The Participant's routing properties.

Fetch Channel Participants

GET https://flex.twilio.com/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants

Path parameters

Property nameTypeRequiredPIIDescription

InteractionSidSID<KD>required

Not PII

The Interaction Sid for this channel.

Pattern: ^KD[0-9a-fA-F]{32}$Min length: 34Max length: 34

ChannelSidSID<UO>required

Not PII

The Channel Sid for this Participant.

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

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeintegerOptional

Not PII

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

Minimum: 1Maximum: 1000

PageintegerOptional

Not PII

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

Minimum: 0

PageTokenstringOptional

Not PII

The page token. This is provided by the API.

Fetch Channel Participants

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_19// Download the helper library from https://www.twilio.com/docs/node/install
_19const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19
_19// Find your Account SID and Auth Token at twilio.com/console
_19// and set the environment variables. See http://twil.io/secure
_19const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19const authToken = process.env.TWILIO_AUTH_TOKEN;
_19const client = twilio(accountSid, authToken);
_19
_19async function listInteractionChannelParticipant() {
_19  const participants = await client.flexApi.v1
_19    .interaction("KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_19    .channels("UOXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_19    .participants.list({ limit: 20 });
_19
_19  participants.forEach((p) => console.log(p.sid));
_19}
_19
_19listInteractionChannelParticipant();

Output


_33{
_33  "participants": [
_33    {
_33      "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
_33      "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
_33      "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_33      "type": "customer",
_33      "routing_properties": null,
_33      "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1"
_33    },
_33    {
_33      "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2",
_33      "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
_33      "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_33      "type": "agent",
_33      "routing_properties": {
_33        "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_33        "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_33        "reservation_sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_33      },
_33      "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/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/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants?PageSize=50&Page=0",
_33    "previous_page_url": null,
_33    "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants?PageSize=50&Page=0",
_33    "next_page_url": null,
_33    "key": "participants"
_33  }
_33}

Modify a Channel Participant

POST https://flex.twilio.com/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

InteractionSidSID<KD>required

Not PII

The Interaction Sid for this channel.

Pattern: ^KD[0-9a-fA-F]{32}$Min length: 34Max length: 34

ChannelSidSID<UO>required

Not PII

The Channel Sid for this Participant.

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

SidSID<UT>required

Not PII

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

Pattern: ^UT[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Property nameTypeRequiredPIIDescription

Statusenum<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

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

Java

PHP

Ruby

twilio-cli

curl


_20// Download the helper library from https://www.twilio.com/docs/node/install
_20const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_20
_20// Find your Account SID and Auth Token at twilio.com/console
_20// and set the environment variables. See http://twil.io/secure
_20const accountSid = process.env.TWILIO_ACCOUNT_SID;
_20const authToken = process.env.TWILIO_AUTH_TOKEN;
_20const client = twilio(accountSid, authToken);
_20
_20async function updateInteractionChannelParticipant() {
_20  const participant = await client.flexApi.v1
_20    .interaction("KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_20    .channels("UOXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_20    .participants("UTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_20    .update({ status: "wrapup" });
_20
_20  console.log(participant.sid);
_20}
_20
_20updateInteractionChannelParticipant();

Output


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

Complete a single agent reservation

This changes the agent reservation status to 'completed'.

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_20// Download the helper library from https://www.twilio.com/docs/node/install
_20const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_20
_20// Find your Account SID and Auth Token at twilio.com/console
_20// and set the environment variables. See http://twil.io/secure
_20const accountSid = process.env.TWILIO_ACCOUNT_SID;
_20const authToken = process.env.TWILIO_AUTH_TOKEN;
_20const client = twilio(accountSid, authToken);
_20
_20async function updateInteractionChannelParticipant() {
_20  const participant = await client.flexApi.v1
_20    .interaction("KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_20    .channels("UOXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_20    .participants("UTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_20    .update({ status: "closed" });
_20
_20  console.log(participant.sid);
_20}
_20
_20updateInteractionChannelParticipant();

Output


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