Retrieve a list of Intelligence Configurations

(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/ControlPlane/Configurations

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

Request

Authentication

Basic Auth

Query string

Property nameTypeRequiredPIIDescription

pageSizeinteger

Optional

Not PII

The maximum number of resources to return

Default: 50Minimum: 1Maximum: 1000

pageTokenstring

Optional

Not PII

Token for pagination

Responses

200429500

An array of Intelligence Configurations.

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

itemsarray[object]

Optional

Not PII

The list of Intelligence Configurations owned by this account.

Show items properties

Property nameTypeRequiredPIIDescriptionChild properties

accountIdstring

Optional

Not PII

The ID of the Account that created the Intelligence Configuration.

Example: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

idstring

Optional

Not PII

The unique identifier for the Intelligence Configuration. Assigned by Twilio (TTID).

displayNamestring

Optional

Not PII

The display name of the Intelligence Configuration describing its purpose.

Min length: 1Max length: 128

descriptionstring

Optional

Not PII

The description of the Intelligence Configuration further explaining its purpose.

versioninteger

Optional

Not PII

The numeric version of the Intelligence Configuration. Automatically incremented with each update on the resource, used to ensure integrity when updating the Configuration.

rulesarray[object]

Optional

Not PII

List of Intelligence Configuration Rules that govern when and how Language Operators run. Each Rule represents a bundle of Operators, Triggers, Context, and Actions to be executed by the Intelligence Configuration on a Conversation. A maximum of five (5) Rules are allowed per Intelligence Configuration.

Max items: 5

Show rules properties

Property nameTypeRequiredPIIDescriptionChild properties

idstring

Optional

Not PII

The unique identifier for the Rule. Assigned by Twilio (TTID).

operatorsarray[object]

Optional

Not PII

List of Operators to be executed by the Rule. Maximum of five (5) Operators allowed per Rule.

Max items: 5

Show operators properties

triggersarray[object]

Optional

Not PII

List of Triggers that determine when to activate the Rule. Maximum of one (1) Trigger allowed per Rule.

Max items: 1

Show triggers properties

actionsarray[object]

Optional

Not PII

List of Actions to be performed after the Rule is triggered. Maximum of two (2) Actions allowed per Rule.

Max items: 2

Show actions properties

contextobject

Optional

Not PII

Controls what additional customer and enterprise context is made available to Language Operators when this Rule executes.

Show context properties

dateCreatedstring<date-time>

Optional

Not PII

Timestamp of when the Intelligence Configuration was created.

dateUpdatedstring<date-time>

Optional

Not PII

Timestamp of when the Intelligence Configuration was last updated.

metaobject

Optional

Not PII

The metadata for Pagination

Show meta properties

{
  "items": [
    {
      "accountId": "AC00000000000000000000000000000000",
      "id": "intelligence_configuration_01kermhm82e5mr98nbeh1hpmbn",
      "displayName": "real-time-intelligence-config",
      "description": "Intelligence configuration to trigger real-time script adherence operator",
      "version": 1,
      "rules": [
        {
          "id": "intelligence_configurationrule_01kermhm81fwfvy7j0f7h7v5mr",
          "operators": [
            {
              "id": "intelligence_operator_01kcgy1ew0e9x8re6jq542zt8b",
              "version": 4,
              "parameters": {
                "scale": 2
              }
            }
          ],
          "triggers": [
            {
              "on": "COMMUNICATION",
              "parameters": {
                "count": 3
              }
            }
          ],
          "actions": [
            {
              "type": "WEBHOOK",
              "method": "POST",
              "url": "https://my-webhook-endpoint.com/rule-action"
            }
          ],
          "context": {
            "memory": {
              "enabled": true
            },
            "knowledge": {
              "bases": [
                "knowledge_base_id"
              ]
            }
          }
        }
      ],
      "dateCreated": "2026-01-12T08:18:17Z",
      "dateUpdated": "2026-01-12T08:18:17Z"
    },
    {
      "accountId": "AC00000000000000000000000000000000",
      "id": "intelligence_configuration_01kermhm92e5mr98nbeh1hpmbz",
      "displayName": "post-call-analytics-config",
      "description": "Intelligence configuration for post-call analytics",
      "version": 2,
      "rules": [
        {
          "id": "intelligence_configurationrule_01kermhm91fwfvy7j0f7h7v5ms",
          "operators": [
            {
              "id": "intelligence_operator_01kcgy1ew0e9x8re6jq542zt9c"
            }
          ],
          "triggers": [
            {
              "on": "CONVERSATION_END"
            }
          ],
          "actions": [
            {
              "type": "WEBHOOK",
              "method": "POST",
              "url": "https://my-webhook-endpoint.com/analytics"
            }
          ],
          "context": {
            "memory": {
              "enabled": false
            }
          }
        }
      ],
      "dateCreated": "2026-01-10T10:30:00Z",
      "dateUpdated": "2026-01-11T14:22:00Z"
    }
  ],
  "meta": {
    "key": "items",
    "pageSize": 2,
    "nextToken": "next_page_token_example"
  }
}

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 Intelligence Configurations

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 listConfigurations() {
14  const configurations = await client.intelligence.v3.configurations.list({
15    limit: 20,
16  });
17
18  configurations.forEach((c) => console.log(c.accountId));
19}
20
21listConfigurations();

Response

1{
2  "items": [
3    {
4      "accountId": "AC00000000000000000000000000000000",
5      "id": "intelligence_configuration_01kermhm82e5mr98nbeh1hpmbn",
6      "displayName": "real-time-intelligence-config",
7      "description": "Intelligence configuration to trigger real-time script adherence operator",
8      "version": 1,
9      "rules": [
10        {
11          "id": "intelligence_configurationrule_01kermhm81fwfvy7j0f7h7v5mr",
12          "operators": [
13            {
14              "id": "intelligence_operator_01kcgy1ew0e9x8re6jq542zt8b",
15              "version": 4,
16              "parameters": {
17                "scale": 2
18              }
19            }
20          ],
21          "triggers": [
22            {
23              "on": "COMMUNICATION",
24              "parameters": {
25                "count": 3
26              }
27            }
28          ],
29          "actions": [
30            {
31              "type": "WEBHOOK",
32              "method": "POST",
33              "url": "https://my-webhook-endpoint.com/rule-action"
34            }
35          ],
36          "context": {
37            "memory": {
38              "enabled": true
39            },
40            "knowledge": {
41              "bases": [
42                "knowledge_base_id"
43              ]
44            }
45          }
46        }
47      ],
48      "dateCreated": "2026-01-12T08:18:17Z",
49      "dateUpdated": "2026-01-12T08:18:17Z"
50    },
51    {
52      "accountId": "AC00000000000000000000000000000000",
53      "id": "intelligence_configuration_01kermhm92e5mr98nbeh1hpmbz",
54      "displayName": "post-call-analytics-config",
55      "description": "Intelligence configuration for post-call analytics",
56      "version": 2,
57      "rules": [
58        {
59          "id": "intelligence_configurationrule_01kermhm91fwfvy7j0f7h7v5ms",
60          "operators": [
61            {
62              "id": "intelligence_operator_01kcgy1ew0e9x8re6jq542zt9c"
63            }
64          ],
65          "triggers": [
66            {
67              "on": "CONVERSATION_END"
68            }
69          ],
70          "actions": [
71            {
72              "type": "WEBHOOK",
73              "method": "POST",
74              "url": "https://my-webhook-endpoint.com/analytics"
75            }
76          ],
77          "context": {
78            "memory": {
79              "enabled": false
80            }
81          }
82        }
83      ],
84      "dateCreated": "2026-01-10T10:30:00Z",
85      "dateUpdated": "2026-01-11T14:22:00Z"
86    }
87  ],
88  "meta": {
89    "key": "items",
90    "pageSize": 2,
91    "nextToken": "next_page_token_example"
92  }
93}