Fetch Communication

(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/{ConversationSid}/Communications/{Sid}

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

Retrieve a Communication.

Request

Authentication

Basic Auth

Path parameters

Property nameTypeRequiredPIIDescription

conversationSidstring

required

Not PII

sidstring

required

Not PII

Responses

200400404429500503

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

idstring

Optional

Not PII

Communication ID.

Example: conv_communication_01k1etk2y5f1y9fpe2epfdtvv2

conversationIdstring

Optional

Not PII

Conversation ID.

Example: conv_conversation_01k1etk2y5f1y9fpe2epfdtvv2

accountIdstring

Optional

Not PII

Account ID.

Example: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

authorobject

Optional

Not PII

Example: {"address":"+18005550100","channel":"SMS","participantId":"conv_participant_01k1etx3jbfx88476ccja0889c"}

Show author properties

content

oneOf:

Optional

Not PII

The content of the Communication using type field for discrimination.

Show content properties

channelIdstring

Optional

Not PII

Channel-specific reference ID.

Example: CA123456789

resourceIdstring

Optional

Not PII

External resource identifier for this Communication (e.g. MessageSid for SMS/RCS/WhatsApp, TranscriptionSid + MessageIndex for Voice). When set, used for Communication deduplication/uniqueness within a Conversation.

Example: SM12345678901234567890123456789012Min length: 1

recipientsarray[object]

Optional

Not PII

Communication recipients.

Show recipients properties

createdAtstring<date-time>

Optional

Not PII

Timestamp when this Communication was created.

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

updatedAtstring<date-time>

Optional

Not PII

Timestamp when this Communication was last updated.

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

occurredAtstring<date-time>

Optional

Not PII

ISO 8601 timestamp when the communication occurred.

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

Fetch Communication

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 and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchCommunication() {
11  const communication = await client.conversations.v2
12    .communications("ConversationSid", "Sid")
13    .fetch();
14
15  console.log(communication.id);
16}
17
18fetchCommunication();

Response

1{
2  "accountId": "ZGkrHSypTsudrGkmdpJJ",
3  "author": {
4    "address": "address",
5    "channel": "SMS",
6    "participantId": "participantId"
7  },
8  "channelId": "channelId",
9  "content": {},
10  "conversationId": "conversationId",
11  "createdAt": "2009-07-06T20:30:00Z",
12  "id": "id",
13  "occurredAt": "2009-07-06T20:30:00Z",
14  "recipients": [
15    {
16      "address": "address",
17      "channel": "SMS",
18      "participantId": "participantId",
19      "deliveryStatus": "INITIATED"
20    }
21  ],
22  "resourceId": "resourceId",
23  "updatedAt": "2009-07-06T20:30:00Z"
24}