Skip to contentSkip to navigationSkip to topbar
Page tools
Useful for sharing or LLM
Accelerate development with AI
On this page
Looking for more inspiration?Visit the

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.

Participant Properties

participant-properties page anchor
Property nameTypeRequiredPIIDescriptionChild properties
sidSID<UT>

Optional

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>

Optional

Not PII

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

Possible values:
supervisorcustomerexternalagentunknown
interactionSidSID<KD>

Optional

Not PII

The Interaction Sid for this channel.

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

Optional

Not PII

The Channel Sid for this Participant.

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

Optional

Not PII
routingProperties

Optional

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

Path parameters

path-parameters page anchor
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

query-parameters page anchor
Property nameTypeRequiredPIIDescription
pageSizeinteger<int64>

Optional

Not PII

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

Minimum: 1Maximum: 1000
pageinteger

Optional

Not PII

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

Minimum: 0
pageTokenstring

Optional

Not PII

The page token. This is provided by the API.

Fetch Channel ParticipantsLink to code sample: Fetch Channel Participants
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

6
// and set the environment variables. See http://twil.io/secure

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function listInteractionChannelParticipant() {

14
  const participants = await client.flexApi.v1

15
    .interaction("KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")

16
    .channels("UOXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")

17
    .participants.list({ limit: 20 });

18


19
  participants.forEach((p) => console.log(p.sid));

20
}

21


22
listInteractionChannelParticipant();

Response

Note about this response
1
{

2
  "participants": [

3
    {

4
      "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",

5
      "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",

6
      "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

7
      "type": "customer",

8
      "routing_properties": null,

9
      "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1"

10
    },

11
    {

12
      "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2",

13
      "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",

14
      "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

15
      "type": "agent",

16
      "routing_properties": {

17
        "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

18
        "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

19
        "reservation_sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

20
      },

21
      "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2"

22
    }

23
  ],

24
  "meta": {

25
    "page": 0,

26
    "page_size": 50,

27
    "first_page_url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants?PageSize=50&Page=0",

28
    "previous_page_url": null,

29
    "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants?PageSize=50&Page=0",

30
    "next_page_url": null,

31
    "key": "participants"

32
  }

33
}

Modify a Channel Participant

modify-a-channel-participant page anchor

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

Path parameters

path-parameters-1 page anchor
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

request-body-parameters page anchor
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredPIIDescriptionChild properties
statusenum<string>
required
Not PII
Possible values:
closedwrapup
Wrap up agent reservationLink to code sample: Wrap up agent reservation
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

6
// and set the environment variables. See http://twil.io/secure

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function updateInteractionChannelParticipant() {

14
  const participant = await client.flexApi.v1

15
    .interaction("KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")

16
    .channels("UOXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")

17
    .participants("UTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")

18
    .update({ status: "wrapup" });

19


20
  console.log(participant.sid);

21
}

22


23
updateInteractionChannelParticipant();

Response

Note about this response
1
{

2
  "sid": "UTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",

3
  "channel_sid": "UOXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",

4
  "interaction_sid": "KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",

5
  "type": "agent",

6
  "routing_properties": {

7
    "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

8
    "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

9
    "reservation_sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

10
  },

11
  "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1"

12
}
Complete a single agent reservationLink to code sample: Complete a single agent reservation
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

6
// and set the environment variables. See http://twil.io/secure

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function updateInteractionChannelParticipant() {

14
  const participant = await client.flexApi.v1

15
    .interaction("KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")

16
    .channels("UOXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")

17
    .participants("UTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")

18
    .update({ status: "closed" });

19


20
  console.log(participant.sid);

21
}

22


23
updateInteractionChannelParticipant();

Response

Note about this response
1
{

2
  "sid": "UTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",

3
  "channel_sid": "UOXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",

4
  "interaction_sid": "KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",

5
  "type": "agent",

6
  "routing_properties": {

7
    "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

8
    "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

9
    "reservation_sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

10
  },

11
  "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1"

12
}