On this page

Operator Resource

The Operator resource represents a Prebuilt or Custom Operator.

Operator Properties

Property nameTypeRequiredDescriptionChild properties

account_sidSID<AC>

Optional

Not PII

The unique SID identifier of the Account the Operator belongs to.

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

sidSID<LY>

Optional

Not PII

A 34 character string that uniquely identifies this Operator.

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

friendly_namestring

Optional

Not PII

A human-readable name of this resource, up to 64 characters.

descriptionstring

Optional

Not PII

A human-readable description of this resource, longer than the friendly name.

authorstring

Optional

Not PII

The creator of the Operator. Either Twilio or the creating Account.

operator_typestring

Optional

Not PII

Operator Type for this Operator. References an existing Operator Type resource.

versioninteger

Optional

Not PII

Numeric Operator version. Incremented with each update on the resource, used to ensure integrity when updating the Operator.

Default: 0

availabilityenum<string>

Optional

Not PII

Operator availability status. Possible values: internal, beta, public, retired.

Possible values:

internalbetapublicretired

configobject

Optional

Not PII

Operator configuration, following the schema defined by the Operator Type. Only available on Custom Operators created by the Account.

date_createdstring<date-time>

Optional

Not PII

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

date_updatedstring<date-time>

Optional

Not PII

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

urlstring<uri>

Optional

Not PII

The URL of this resource.

Fetch an Operator

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

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

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<LY>required

Not PII

A 34 character string that uniquely identifies this Operator.

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

Fetch an Operator

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

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/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
18}

List Operators

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

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

Query parameters

Property nameTypeRequiredPIIDescription

Availabilityenum<string>

Optional

Not PII

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

Possible values:

internalbetapublicretired

LanguageCodestring

Optional

Not PII

Returns Operators that support the provided language code.

PageSizeinteger

Optional

Not PII

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

Minimum: 1Maximum: 1000

Pageinteger

Optional

Not PII

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

Minimum: 0

PageTokenstring

Optional

Not PII

The page token. This is provided by the API.

List multiple Operators

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

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/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
20    }
21  ],
22  "meta": {
23    "first_page_url": "https://intelligence.twilio.com/v2/Operators?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?LanguageCode=en&Availability=public&PageSize=50&Page=0"
30  }
31}