List Participants

(information)

Legal information

Conversation Orchestrator, including the APIs, may use artificial intelligence or machine learning technologies and is subject to the terms of the Predictive and Generative AI/ML Features Addendum. For details on AI usage and data, see the AI Nutrition Facts for Real-Time Transcription and Conversation Relay.

Conversation Orchestrator is not a HIPAA Eligible Service or PCI compliant and should not be enabled in workflows that are subject to HIPAA or PCI.

Conversations products are only available in the new Twilio Console. If your account hasn't been migrated, you'll be redirected to the legacy Console where these products won't appear.

GET/v2/Conversations/{ConversationId}/Participants

Base url: https://conversations.twilio.com (base url)

Retrieve a list of Participants in a Conversation.

Request

Authentication

Basic Auth

Path parameters

Property nameTypeRequiredPIIDescription

conversationIdstring

required

Not PII

Query string

Property nameTypeRequiredPIIDescription

pageSizeinteger

Optional

Not PII

Maximum number of items to return

Default: 50Example: 50Minimum: 1Maximum: 1000

pageTokenstring

Optional

Not PII

Page token for pagination

Responses

200400404429500503

Schema

Property nameTypeRequiredPIIDescriptionChild properties

participantsarray[object]

Optional

Not PII

Show participants properties

Property nameTypeRequiredPIIDescriptionChild properties

idstring

Optional

Not PII

Participant ID.

Example: conv_participant_00000000000000000000000001

conversationIdstring

Optional

Not PII

Conversation ID.

Example: conv_conversation_00000000000000000000000001

accountIdstring

Optional

Not PII

Account ID.

Example: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

namestring

Optional

Not PII

Participant display name.

Example: Dana S.

typeenum<string>

Optional

Not PII

Type of Participant in the Conversation.

Example: CUSTOMERPossible values:

HUMAN_AGENTCUSTOMERAI_AGENTAGENTUNKNOWN

profileIdstring

Optional

Not PII

Profile ID. Note: This field is only resolved for CUSTOMER participant types, not for HUMAN_AGENT or AI_AGENT participants.

Example: mem_profile_00000000000000000000000000

addressesarray[object]

Optional

Not PII

Communication addresses for this Participant. Address format varies by channel:

SMS/VOICE: E.164 phone number (such as "+18005550100")
EMAIL: Email address (such as "user@example.com")
WHATSAPP: Phone number with whatsapp prefix (such as "whatsapp:+18005550100")
RCS: Sender ID or phone number with rcs prefix (such as "rcs:brand_acme_agent" or "rcs:+18005550100")

Show addresses properties

createdAtstring<date-time>

Optional

Not PII

Timestamp when this Participant was created.

Example: 2023-07-01T12:00:00Z

updatedAtstring<date-time>

Optional

Not PII

Timestamp when this Participant was last updated.

Example: 2023-07-01T12:00:00Z

metaobject

Optional

Not PII

Show meta properties

List Participants

1// Download the helper library from https://www.twilio.com/docs/node/install
2const 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
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function listParticipantByConversation() {
14  const participants = await client.conversations.v2
15    .participants("ConversationId")
16    .list({ limit: 20 });
17
18  participants.forEach((p) => console.log(p.id));
19}
20
21listParticipantByConversation();

Response

1{
2  "meta": {
3    "key": "participants",
4    "pageSize": 42,
5    "previousToken": "previousToken",
6    "nextToken": "nextToken"
7  },
8  "participants": [
9    {
10      "id": "conv_participant_00000000000000000000000001",
11      "conversationId": "conv_conversation_00000000000000000000000001",
12      "accountId": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13      "name": "Dana",
14      "type": "CUSTOMER",
15      "profileId": "mem_profile_00000000000000000000000000",
16      "addresses": [
17        {
18          "channel": "SMS",
19          "address": "+18005550100"
20        },
21        {
22          "channel": "WHATSAPP",
23          "address": "whatsapp:+18005550100"
24        },
25        {
26          "channel": "RCS",
27          "address": "rcs:+18005550100"
28        }
29      ],
30      "createdAt": "2023-07-01T12:00:00Z",
31      "updatedAt": "2023-07-01T12:30:00Z"
32    }
33  ]
34}