Operator configuration, following the schema defined by the Operator Type. Only available on Custom Operators created by the Account, will be empty for Pre-Built Operators.

date_createdstring<date-time>Optional

Not PII

The date that this Pre-built Operator was created, given in ISO 8601 format.

date_updatedstring<date-time>Optional

Not PII

The date that this Pre-built Operator was updated, given in ISO 8601 format.

urlstring<uri>Optional

Not PII

The URL of this resource.

Fetch a Prebuilt Operator

GET https://intelligence.twilio.com/v2/Operators/PreBuilt/{Sid}

This endpoint retrieves the details of a Prebuilt Operator using its SID.

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<LY>required

Not PII

A 34 character string that uniquely identifies this Pre-built Operator.

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

Fetch a PreBuilt

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 fetchPrebuiltOperator() {
11  const prebuiltOperator = await client.intelligence.v2
12    .prebuiltOperators("LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .fetch();
14
15  console.log(prebuiltOperator.accountSid);
16}
17
18fetchPrebuiltOperator();

Output

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "My New Operator",
5  "description": "New Operator",
6  "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7  "operator_type": "operator-type-name",
8  "version": 1,
9  "availability": "public",
10  "config": {
11    "configuration": {
12      "field": "value"
13    }
14  },
15  "date_created": "2010-08-31T20:36:28Z",
16  "date_updated": "2010-08-31T20:36:28Z",
17  "url": "https://intelligence.twilio.com/v2/Operators/PreBuilt/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
18}

List Prebuilt Operators

GET https://intelligence.twilio.com/v2/Operators/PreBuilt

This endpoint lists all available Prebuilt Operators for an Account, with optional filtering.

Query parameters

Property nameTypeRequiredPIIDescription

Availabilityenum<string>Optional

Not PII

Returns Pre-built Operators with the provided availability type. Possible values: internal, beta, public, retired.

Possible values:

internalbetapublicretired

LanguageCodestringOptional

Not PII

Returns Pre-built Operators that support the provided language code.

PageSizeintegerOptional

Not PII

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

PageintegerOptional

Not PII

The page index. This value is simply for client state.

Minimum: 0

PageTokenstringOptional

Not PII

The page token. This is provided by the API.

List multiple PreBuilts

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 listPrebuiltOperator() {
11  const prebuiltOperators = await client.intelligence.v2.prebuiltOperators.list(
12    { limit: 20 }
13  );
14
15  prebuiltOperators.forEach((p) => console.log(p.accountSid));
16}
17
18listPrebuiltOperator();

Output

1{
2  "operators": [
3    {
4      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5      "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6      "friendly_name": "My New Operator",
7      "description": "New Operator",
8      "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
9      "operator_type": "operator-type-name",
10      "version": 1,
11      "availability": "public",
12      "config": {
13        "configuration": {
14          "field": "value"
15        }
16      },
17      "date_created": "2010-08-31T20:36:28Z",
18      "date_updated": "2010-08-31T20:36:28Z",
19      "url": "https://intelligence.twilio.com/v2/Operators/PreBuilt/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
20    }
21  ],
22  "meta": {
23    "first_page_url": "https://intelligence.twilio.com/v2/Operators/PreBuilt?LanguageCode=en&Availability=public&PageSize=50&Page=0",
24    "key": "operators",
25    "next_page_url": null,
26    "page": 0,
27    "page_size": 50,
28    "previous_page_url": null,
29    "url": "https://intelligence.twilio.com/v2/Operators/PreBuilt?LanguageCode=en&Availability=public&PageSize=50&Page=0"
30  }
31}