Retrieve a Conversation

(information)

Legal information

Conversation Intelligence, 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 more details on AI usage and data, see AI Nutrition Facts for Conversation Intelligence.

Conversation Intelligence is not PCI compliant or a HIPAA Eligible Service and should not be used 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/v3/Conversations/{id}

Base url: https://intelligence.twilio.com (Twilio Intelligence API)

Request

Authentication

Basic Auth

Path parameters

Property nameTypeRequiredPIIDescription

idstring

required

Not PII

The unique identifier of the conversation.

Example: conv_conversation_01k1etk2y5f1y9fpe2epfdtvv2Pattern: ^conv_conversation_[0-7][0-9a-z]{25}$

Responses

200400401403404429500

Conversation object.

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

idstring

Optional

Not PII

The id of the Conversation attached to the Operator Result.

Example: conv_conversation_01k1etk2y5f1y9fpe2epfdtvv2Pattern: ^conv_conversation_[0-7][0-9a-z]{25}$

accountIdSID<AC>

Optional

Not PII

The ID of the account that owns the Conversation.

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

namestring

Optional

Not PII

Display name of the Conversation.

statusenum<string>

Optional

Not PII

The status of the Conversation.

Possible values:

ACTIVEINACTIVECLOSED

createdAtstring<date-time>

Optional

Not PII

Timestamp for when the Conversation was created.

updatedAtstring<date-time>

Optional

Not PII

Timestamp for when the Conversation was last updated.

intelligenceConfigurationIdsarray[string]

Optional

Not PII

The Intelligence Configuration(s) associated with the Conversation.

conversationConfigurationIdstring

Optional

Not PII

The id of the Configuration for a Conversation.

Example: conv_configuration_00000000000000000000000000

channelsarray[enum<string>]

Optional

Not PII

The communication channel(s) included in the Conversation.

Possible values:

VOICESMSRCSEMAILWHATSAPPCHATAPISYSTEM

channelIdsarray[string]

Optional

Not PII

The underlying channel resource ids associated with this Conversation, such as a Call ID or Message ID.

participantsarray[object]

Optional

Not PII

Metadata for Participants of the Conversation.

Show participants properties

communicationsarray[object]

Optional

Not PII

Metadata for the Communications that make up the Conversation.

Show communications properties

operatorResultIdsarray[string]

Optional

Not PII

List of Operator Result IDs generated from this Conversation.

{
  "id": "conv_conversation_01k1etk2y5f1y9fpe2epfdtvv2",
  "accountId": "AC00000000000000000000000000000000",
  "name": "Customer Support Call - Order #12345",
  "status": "CLOSED",
  "createdAt": "2026-01-15T10:30:00Z",
  "updatedAt": "2026-01-15T10:45:30Z",
  "intelligenceConfigurationIds": [
    "intelligence_configuration_01kermhm82e5mr98nbeh1hpmbn"
  ],
  "conversationConfigurationId": "conv_configuration_00000000000000000000000000",
  "channels": [
    "VOICE"
  ],
  "channelIds": [
    "CA1234567890abcdef1234567890abcdef"
  ],
  "participants": [
    {
      "id": "conv_participant_01k1etx3jbfx88476ccja0889c",
      "name": "John Customer",
      "type": "CUSTOMER",
      "addressValues": [
        "+15551234567"
      ]
    },
    {
      "id": "conv_participant_01k1etx3jbfx88476ccja0889d",
      "name": "Sarah Agent",
      "type": "HUMAN_AGENT",
      "addressValues": [
        "agent-sarah@example.com"
      ]
    }
  ],
  "communications": [
    {
      "id": "conv_communication_01k1etk2y5f1y9fpe2epfdtvv2",
      "participantId": "conv_participant_01k1etx3jbfx88476ccja0889d",
      "content": {
        "text": "Thank you for calling customer support. How can I help you today?"
      },
      "createdAt": "2026-01-15T10:30:15Z"
    },
    {
      "id": "conv_communication_01k1etk2y5f1y9fpe2epfdtvv3",
      "participantId": "conv_participant_01k1etx3jbfx88476ccja0889c",
      "content": {
        "text": "Hi, I need help tracking my order #12345."
      },
      "createdAt": "2026-01-15T10:30:30Z"
    },
    {
      "id": "conv_communication_01k1etk2y5f1y9fpe2epfdtvv9",
      "participantId": "conv_participant_01k1etx3jbfx88476ccja0889d",
      "content": {
        "text": "I'd be happy to help you with that. Let me look up your order."
      },
      "createdAt": "2026-01-15T10:30:45Z"
    }
  ],
  "operatorResultIds": [
    "intelligence_operatorresult_01k6fc25s7epm9qtk8rszbv3q5",
    "intelligence_operatorresult_01k6fc25s7epm9qtk8rszbv3q6"
  ]
}

Bad request

Schema

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

Not PII

Twilio-specific error code

messagestring

Optional

Not PII

A human readable error message

httpStatusCodeinteger<int32>

Optional

Not PII

HTTP response status code

userErrorboolean

Optional

Not PII

Whether the error is a user error (true) or a system error (false)

paramsobject

Optional

Not PII

A map of parameters related to the error, for example, a params.twilioErrorCodeUrl might hold a URL or link to additional information

Show params properties

Unauthorized request

Schema

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

Not PII

Twilio-specific error code

messagestring

Optional

Not PII

A human readable error message

httpStatusCodeinteger<int32>

Optional

Not PII

HTTP response status code

userErrorboolean

Optional

Not PII

Whether the error is a user error (true) or a system error (false)

paramsobject

Optional

Not PII

A map of parameters related to the error, for example, a params.twilioErrorCodeUrl might hold a URL or link to additional information

Show params properties

Forbidden request

Schema

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

Not PII

Twilio-specific error code

messagestring

Optional

Not PII

A human readable error message

httpStatusCodeinteger<int32>

Optional

Not PII

HTTP response status code

userErrorboolean

Optional

Not PII

Whether the error is a user error (true) or a system error (false)

paramsobject

Optional

Not PII

A map of parameters related to the error, for example, a params.twilioErrorCodeUrl might hold a URL or link to additional information

Show params properties

Resource not found

Schema

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

Not PII

Twilio-specific error code

messagestring

Optional

Not PII

A human readable error message

httpStatusCodeinteger<int32>

Optional

Not PII

HTTP response status code

userErrorboolean

Optional

Not PII

Whether the error is a user error (true) or a system error (false)

paramsobject

Optional

Not PII

A map of parameters related to the error, for example, a params.twilioErrorCodeUrl might hold a URL or link to additional information

Show params properties

Too Many requests (rate limit exceeded for request originating from public API)

Schema

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

Not PII

Twilio-specific error code

messagestring

Optional

Not PII

A human readable error message

httpStatusCodeinteger<int32>

Optional

Not PII

HTTP response status code

userErrorboolean

Optional

Not PII

Whether the error is a user error (true) or a system error (false)

paramsobject

Optional

Not PII

A map of parameters related to the error, for example, a params.twilioErrorCodeUrl might hold a URL or link to additional information

Show params properties

Internal server error

Schema

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

Not PII

Twilio-specific error code

messagestring

Optional

Not PII

A human readable error message

httpStatusCodeinteger<int32>

Optional

Not PII

HTTP response status code

userErrorboolean

Optional

Not PII

Whether the error is a user error (true) or a system error (false)

paramsobject

Optional

Not PII

A map of parameters related to the error, for example, a params.twilioErrorCodeUrl might hold a URL or link to additional information

Show params properties

Retrieve a Conversation

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 fetchConversation() {
11  const conversation = await client.intelligence.v3
12    .conversations("conv_conversation_01k1etk2y5f1y9fpe2epfdtvv2")
13    .fetch();
14
15  console.log(conversation.id);
16}
17
18fetchConversation();

Response

1{
2  "id": "conv_conversation_01k1etk2y5f1y9fpe2epfdtvv2",
3  "accountId": "AC00000000000000000000000000000000",
4  "name": "Customer Support Call - Order #12345",
5  "status": "CLOSED",
6  "createdAt": "2026-01-15T10:30:00Z",
7  "updatedAt": "2026-01-15T10:45:30Z",
8  "intelligenceConfigurationIds": [
9    "intelligence_configuration_01kermhm82e5mr98nbeh1hpmbn"
10  ],
11  "conversationConfigurationId": "conv_configuration_00000000000000000000000000",
12  "channels": [
13    "VOICE"
14  ],
15  "channelIds": [
16    "CA1234567890abcdef1234567890abcdef"
17  ],
18  "participants": [
19    {
20      "id": "conv_participant_01k1etx3jbfx88476ccja0889c",
21      "name": "John Customer",
22      "type": "CUSTOMER",
23      "addressValues": [
24        "+15551234567"
25      ]
26    },
27    {
28      "id": "conv_participant_01k1etx3jbfx88476ccja0889d",
29      "name": "Sarah Agent",
30      "type": "HUMAN_AGENT",
31      "addressValues": [
32        "agent-sarah@example.com"
33      ]
34    }
35  ],
36  "communications": [
37    {
38      "id": "conv_communication_01k1etk2y5f1y9fpe2epfdtvv2",
39      "participantId": "conv_participant_01k1etx3jbfx88476ccja0889d",
40      "content": {
41        "text": "Thank you for calling customer support. How can I help you today?"
42      },
43      "createdAt": "2026-01-15T10:30:15Z"
44    },
45    {
46      "id": "conv_communication_01k1etk2y5f1y9fpe2epfdtvv3",
47      "participantId": "conv_participant_01k1etx3jbfx88476ccja0889c",
48      "content": {
49        "text": "Hi, I need help tracking my order #12345."
50      },
51      "createdAt": "2026-01-15T10:30:30Z"
52    },
53    {
54      "id": "conv_communication_01k1etk2y5f1y9fpe2epfdtvv9",
55      "participantId": "conv_participant_01k1etx3jbfx88476ccja0889d",
56      "content": {
57        "text": "I'd be happy to help you with that. Let me look up your order."
58      },
59      "createdAt": "2026-01-15T10:30:45Z"
60    }
61  ],
62  "operatorResultIds": [
63    "intelligence_operatorresult_01k6fc25s7epm9qtk8rszbv3q5",
64    "intelligence_operatorresult_01k6fc25s7epm9qtk8rszbv3q6"
65  ]
66}