On this page

Voice Intelligence - OperatorType Resource

The OperatorType resource represents the different Operator Types you can attach to your Voice Intelligence Service. If an Operator Type is configurable, you can create a Custom Operator for it. This resource allows you to fetch a specific Operator Type or list all available Operator Types.

OperatorType Properties

Property nameTypeRequiredDescriptionChild properties

namestring

Optional

A unique name that references an Operator's Operator Type.

sidSID<EY>

Optional

A 34 character string that uniquely identifies this Operator Type.

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

friendly_namestring

Optional

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

descriptionstring

Optional

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

docs_linkstring<uri>

Optional

Additional documentation for the Operator Type.

output_typeenum<string>

Optional

Operator Results for this Operator Type will follow this format. Possible values: text-classification, text-extraction, text-extraction-normalized, text-generation.

Possible values:

text-classificationtext-extractiontext-extraction-normalizedtext-generation

supported_languagesarray[string]

Optional

List of languages this Operator Type supports.

providerenum<string>

Optional

Operators with this Operator Type are executed using this provider. Possible values: twilio, amazon, openai.

Possible values:

twilioamazonopenai

availabilityenum<string>

Optional

Operator Type availability status. Possible values: internal, beta, general-availability, retired, deprecated.

Possible values:

internalbetageneral-availabilityretireddeprecated

configurableboolean

Optional

Operators can be created from configurable Operator Types.

config_schemaobject

Optional

JSON Schema for configuring an Operator with this Operator Type. Following https://json-schema.org/

date_createdstring<date-time>

Optional

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

date_updatedstring<date-time>

Optional

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

urlstring<uri>

Optional

The URL of this resource.

Fetch an Operator Type

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

This endpoint allows you to retrieve the details of an Operator Type using its SID or name. The response includes information such as supported languages, output types, whether an Operator Type is configurable, and a configuration schema with a list of required and optional properties.

Path parameters

Property nameTypeRequiredPIIDescription

Sidstringrequired

Either a 34 character string that uniquely identifies this Operator Type or the unique name that references an Operator Type.

Fetch an Operator Type by SID

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 fetchOperatorType() {
11  const operatorType = await client.intelligence.v2
12    .operatorType("EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .fetch();
14
15  console.log(operatorType.name);
16}
17
18fetchOperatorType();

Output

1{
2  "name": "Summarization",
3  "sid": "EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "Summarize Conversations",
5  "description": "Summarize Conversations",
6  "docs_link": "/docs/voice/intelligence/key-concepts#language-operators",
7  "output_type": "text-generation",
8  "supported_languages": [
9    "en"
10  ],
11  "provider": "openai",
12  "availability": "general-availability",
13  "configurable": true,
14  "config_schema": {
15    "field": "value"
16  },
17  "date_created": "2010-08-31T20:36:28Z",
18  "date_updated": "2010-08-31T20:36:28Z",
19  "url": "https://intelligence.twilio.com/v2/OperatorTypes/EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
20}

List available Operator Types

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

This endpoint lists all available Operator Types for an Account.

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeinteger<int64>

Optional

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

Minimum: 1Maximum: 1000

Pageinteger

Optional

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

Minimum: 0

PageTokenstring

Optional

The page token. This is provided by the API.

List multiple OperatorTypes

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

Output

1{
2  "operator_types": [
3    {
4      "name": "Summarization",
5      "sid": "EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6      "friendly_name": "Summarize Conversations",
7      "description": "Summarize Conversations",
8      "docs_link": "/docs/voice/intelligence/key-concepts#language-operators",
9      "output_type": "text-generation",
10      "supported_languages": [
11        "en"
12      ],
13      "provider": "openai",
14      "availability": "general-availability",
15      "configurable": true,
16      "config_schema": {
17        "field": "value"
18      },
19      "date_created": "2010-08-31T20:36:28Z",
20      "date_updated": "2010-08-31T20:36:28Z",
21      "url": "https://intelligence.twilio.com/v2/OperatorTypes/EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
22    }
23  ],
24  "meta": {
25    "first_page_url": "https://intelligence.twilio.com/v2/OperatorTypes?PageSize=50&Page=0",
26    "key": "operator_types",
27    "next_page_url": null,
28    "page": 0,
29    "page_size": 50,
30    "previous_page_url": null,
31    "url": "https://intelligence.twilio.com/v2/OperatorTypes?PageSize=50&Page=0"
32  }
33}