Retrieve a list of OperatorResults

(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/OperatorResults

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

Request

Authentication

Basic Auth

Query string

Property nameTypeRequiredPIIDescription

conversationIdstring

Optional

Not PII

Filter Operator Results by attached Conversation id.

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

intelligenceConfigurationIdstring

Optional

Not PII

Filter Operator Results by Intelligence Configuration id used to generate them.

Example: intelligence_configuration_01k6fc25s7epm9qtk8rszbv3q5Pattern: ^intelligence_configuration_[0-7][0-9a-z]{25}$

operatorIdstring

read-only

Optional

Not PII

Filter Operator Results by Language Operator id.

Example: intelligence_operator_01k6fc25s7epm9qtk8rszbv3q5Pattern: ^intelligence_operator_[0-7][0-9a-z]{25}$

pageSizeinteger

Optional

Not PII

The maximum number of resources to return

Default: 50Minimum: 1Maximum: 1000

pageTokenstring

Optional

Not PII

Token for pagination

Responses

200400429500

An array of Operator Results.

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

items

array(oneOf):

Optional

Not PII

List of Operator Results matching the query.

Show items properties

Property nameTypeRequiredPIIDescriptionChild properties

outputFormatstring

Optional

Not PII

The output format set on the Operator that generated this result. Determines the structure of the result object.

Pattern: ^(CLASSIFICATION|TEXT|EXTRACTION|JSON)$

idstring

Optional

Not PII

A unique identifier for the Operator Result. Assigned by Twilio (TTID).

Example: intelligence_operatorresult_01k6fc25s7epm9qtk8rszbv3q5Pattern: ^intelligence_operatorresult_[0-7][0-9a-z]{25}$

accountIdstring

Optional

Not PII

The ID of the Account that created the Language Operator.

Pattern: ^AC[a-zA-Z0-9]{32}$

intelligenceConfigurationobject

Optional

Not PII

Reference to the Intelligence Configuration that generated the Operator Result.

Show intelligenceConfiguration properties

conversationIdstring

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}$

operatorobject

Optional

Not PII

Reference to the Language Operator that generated the Operator Result.

Show operator properties

dateCreatedstring<date-time>

Optional

Not PII

Timestamp for when the Operator Result was created.

referenceIdsarray[string]

Optional

Not PII

The ids of objects related to this Operator Result.

executionDetailsobject

Optional

Not PII

Details about the conditions under which the Operator executed.

Show executionDetails properties

Property nameTypeRequiredPIIDescriptionChild properties

triggerobject

Optional

Not PII

Metadata for the trigger that generated this Operator Result.

Show trigger properties

communicationsobject

Optional

Not PII

Range of first and last communications in the Conversation that were processed during this Operator execution.

Show communications properties

channelsarray[string]

Optional

Not PII

Communication channels included in the Conversation when this Operator was executed.

participantsarray[object]

Optional

Not PII

Metadata for the participants included in the Conversation when this Operator executed.

Show participants properties

resolvedContextobject

Optional

Not PII

The context that was actually used by the operator during execution

Show resolvedContext properties

metadataobject

Optional

Not PII

Show metadata properties

resultobject

Optional

Not PII

The actual result from executing the Language Operator with TEXT output format.

Show result properties

metaobject

Optional

Not PII

Show meta properties

{
  "items": [
    {
      "id": "intelligence_operatorresult_01k6fc25s7epm9qtk8rszbv3q5",
      "accountId": "AC00000000000000000000000000000000",
      "outputFormat": "JSON",
      "intelligenceConfiguration": {
        "id": "intelligence_configuration_01kermhm82e5mr98nbeh1hpmbn",
        "ruleId": "intelligence_configurationrule_01kermhm81fwfvy7j0f7h7v5mr",
        "version": 1
      },
      "conversationId": "conv_conversation_01k1etk2y5f1y9fpe2epfdtvv2",
      "operator": {
        "id": "intelligence_operator_01kcgy1ew0e9x8re6jq542zt8b",
        "version": 1,
        "parameters": {
          "scale": 5
        }
      },
      "dateCreated": "2026-01-15T10:45:30Z",
      "referenceIds": [
        "conv_communication_01k1etk2y5f1y9fpe2epfdtvv2"
      ],
      "executionDetails": {
        "trigger": {
          "on": "CONVERSATION_END",
          "timestamp": "2026-01-15T10:45:25Z"
        },
        "communications": {
          "first": "conv_communication_01k1etk2y5f1y9fpe2epfdtvv2",
          "last": "conv_communication_01k1etk2y5f1y9fpe2epfdtvv9"
        },
        "channels": [
          "VOICE"
        ],
        "participants": [
          {
            "id": "conv_participant_01k1etx3jbfx88476ccja0889c",
            "profileId": "mem_profile_01k6fbz0v4f4e9qtk8p8z7y3w1",
            "type": "CUSTOMER"
          },
          {
            "id": "conv_participant_01k1etx3jbfx88476ccja0889d",
            "type": "HUMAN_AGENT"
          }
        ],
        "resolvedContext": {
          "memory": {
            "profileId": "mem_profile_00000000000000000000000000",
            "memoryStoreId": "mem_store_00000000000000000000000000"
          },
          "knowledge": {
            "sources": [
              {
                "baseId": "know_knowledgebase_00000000000000000000000000",
                "sourceId": "know_knowledge_00000000000000000000000000"
              }
            ]
          }
        }
      },
      "result": {
        "score": 5,
        "explanation": "The agent followed the script closely and addressed all key points effectively."
      }
    },
    {
      "id": "intelligence_operatorresult_01k6fc25s7epm9qtk8rszbv3q6",
      "accountId": "AC00000000000000000000000000000000",
      "outputFormat": "CLASSIFICATION",
      "intelligenceConfiguration": {
        "id": "intelligence_configuration_01kermhm82e5mr98nbeh1hpmbn",
        "ruleId": "intelligence_configurationrule_01kermhm81fwfvy7j0f7h7v5mr",
        "version": 1
      },
      "conversationId": "conv_conversation_01k1etk2y5f1y9fpe2epfdtvv2",
      "operator": {
        "id": "intelligence_operator_01kcgy1ew0e9x8re6jq542zt9c",
        "version": 2,
        "parameters": {}
      },
      "dateCreated": "2026-01-15T10:45:35Z",
      "referenceIds": [
        "conv_communication_01k1etk2y5f1y9fpe2epfdtvv2"
      ],
      "executionDetails": {
        "trigger": {
          "on": "CONVERSATION_END",
          "timestamp": "2026-01-15T10:45:25Z"
        },
        "communications": {
          "first": "conv_communication_01k1etk2y5f1y9fpe2epfdtvv2",
          "last": "conv_communication_01k1etk2y5f1y9fpe2epfdtvv9"
        },
        "channels": [
          "VOICE"
        ],
        "participants": [
          {
            "id": "conv_participant_01k1etx3jbfx88476ccja0889c",
            "type": "CUSTOMER"
          },
          {
            "id": "conv_participant_01k1etx3jbfx88476ccja0889d",
            "type": "HUMAN_AGENT"
          }
        ]
      },
      "result": {
        "label": "POSITIVE"
      }
    }
  ],
  "meta": {
    "key": "items",
    "pageSize": 2,
    "nextToken": "next_page_token_example"
  }
}

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

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 list of OperatorResults

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 listOperatorResults() {
11  const operatorResults = await client.intelligence.v3.operatorResults.list({
12    limit: 20,
13  });
14
15  operatorResults.forEach((o) => console.log(o.outputFormat));
16}
17
18listOperatorResults();

Response

1{
2  "items": [
3    {
4      "id": "intelligence_operatorresult_01k6fc25s7epm9qtk8rszbv3q5",
5      "accountId": "AC00000000000000000000000000000000",
6      "outputFormat": "JSON",
7      "intelligenceConfiguration": {
8        "id": "intelligence_configuration_01kermhm82e5mr98nbeh1hpmbn",
9        "ruleId": "intelligence_configurationrule_01kermhm81fwfvy7j0f7h7v5mr",
10        "version": 1
11      },
12      "conversationId": "conv_conversation_01k1etk2y5f1y9fpe2epfdtvv2",
13      "operator": {
14        "id": "intelligence_operator_01kcgy1ew0e9x8re6jq542zt8b",
15        "version": 1,
16        "parameters": {
17          "scale": 5
18        }
19      },
20      "dateCreated": "2026-01-15T10:45:30Z",
21      "referenceIds": [
22        "conv_communication_01k1etk2y5f1y9fpe2epfdtvv2"
23      ],
24      "executionDetails": {
25        "trigger": {
26          "on": "CONVERSATION_END",
27          "timestamp": "2026-01-15T10:45:25Z"
28        },
29        "communications": {
30          "first": "conv_communication_01k1etk2y5f1y9fpe2epfdtvv2",
31          "last": "conv_communication_01k1etk2y5f1y9fpe2epfdtvv9"
32        },
33        "channels": [
34          "VOICE"
35        ],
36        "participants": [
37          {
38            "id": "conv_participant_01k1etx3jbfx88476ccja0889c",
39            "profileId": "mem_profile_01k6fbz0v4f4e9qtk8p8z7y3w1",
40            "type": "CUSTOMER"
41          },
42          {
43            "id": "conv_participant_01k1etx3jbfx88476ccja0889d",
44            "type": "HUMAN_AGENT"
45          }
46        ],
47        "resolvedContext": {
48          "memory": {
49            "profileId": "mem_profile_00000000000000000000000000",
50            "memoryStoreId": "mem_store_00000000000000000000000000"
51          },
52          "knowledge": {
53            "sources": [
54              {
55                "baseId": "know_knowledgebase_00000000000000000000000000",
56                "sourceId": "know_knowledge_00000000000000000000000000"
57              }
58            ]
59          }
60        }
61      },
62      "result": {
63        "score": 5,
64        "explanation": "The agent followed the script closely and addressed all key points effectively."
65      }
66    },
67    {
68      "id": "intelligence_operatorresult_01k6fc25s7epm9qtk8rszbv3q6",
69      "accountId": "AC00000000000000000000000000000000",
70      "outputFormat": "CLASSIFICATION",
71      "intelligenceConfiguration": {
72        "id": "intelligence_configuration_01kermhm82e5mr98nbeh1hpmbn",
73        "ruleId": "intelligence_configurationrule_01kermhm81fwfvy7j0f7h7v5mr",
74        "version": 1
75      },
76      "conversationId": "conv_conversation_01k1etk2y5f1y9fpe2epfdtvv2",
77      "operator": {
78        "id": "intelligence_operator_01kcgy1ew0e9x8re6jq542zt9c",
79        "version": 2,
80        "parameters": {}
81      },
82      "dateCreated": "2026-01-15T10:45:35Z",
83      "referenceIds": [
84        "conv_communication_01k1etk2y5f1y9fpe2epfdtvv2"
85      ],
86      "executionDetails": {
87        "trigger": {
88          "on": "CONVERSATION_END",
89          "timestamp": "2026-01-15T10:45:25Z"
90        },
91        "communications": {
92          "first": "conv_communication_01k1etk2y5f1y9fpe2epfdtvv2",
93          "last": "conv_communication_01k1etk2y5f1y9fpe2epfdtvv9"
94        },
95        "channels": [
96          "VOICE"
97        ],
98        "participants": [
99          {
100            "id": "conv_participant_01k1etx3jbfx88476ccja0889c",
101            "type": "CUSTOMER"
102          },
103          {
104            "id": "conv_participant_01k1etx3jbfx88476ccja0889d",
105            "type": "HUMAN_AGENT"
106          }
107        ]
108      },
109      "result": {
110        "label": "POSITIVE"
111      }
112    }
113  ],
114  "meta": {
115    "key": "items",
116    "pageSize": 2,
117    "nextToken": "next_page_token_example"
118  }
119}