Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

OperatorType Resource


The OperatorType resource represents the Type of a Prebuilt or Custom Operator.


OperatorType Properties

operatortype-properties page anchor
Property nameTypePIIDescription
namestring
Not PII

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


sidSID<EY>

A 34 character string that uniquely identifies this Operator Type.

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

friendly_namestring

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


descriptionstring

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


docs_linkstring<uri>

Additional documentation for the Operator Type.


output_typeenum<string>

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]

List of languages this Operator Type supports.


providerenum<string>

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

Possible values:
twilioamazonopenai

availabilityenum<string>

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

Possible values:
internalbetapublicretired

configurableboolean

Operators can be created from configurable Operator Types.


config_schemaobject

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


date_createdstring<date-time>

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


date_updatedstring<date-time>

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


urlstring<uri>

The URL of this resource.


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

This endpoint retrieves the details of an Operator Type using its SID.

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
SidSID<EY>required

A 34 character string that uniquely identifies this Operator Type.

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

Fetch an OperatorType

fetch-an-operatortype page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_14
// Download the helper library from https://www.twilio.com/docs/node/install
_14
import twilio from "twilio";
_14
_14
// Find your Account SID and Auth Token at twilio.com/console
_14
// and set the environment variables. See http://twil.io/secure
_14
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_14
const authToken = process.env.TWILIO_AUTH_TOKEN;
_14
const client = twilio(accountSid, authToken);
_14
_14
const operatorType = await client.intelligence.v2
_14
.operatorType("EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_14
.fetch();
_14
_14
console.log(operatorType.name);

Output

_20
{
_20
"name": "Summarization",
_20
"sid": "EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_20
"friendly_name": "Summarize Conversations",
_20
"description": "Summarize Conversations",
_20
"docs_link": "/docs/voice/intelligence/key-concepts#language-operators",
_20
"output_type": "text-generation",
_20
"supported_languages": [
_20
"en"
_20
],
_20
"provider": "openai",
_20
"availability": "public",
_20
"configurable": true,
_20
"config_schema": {
_20
"field": "value"
_20
},
_20
"date_created": "2010-08-31T20:36:28Z",
_20
"date_updated": "2010-08-31T20:36:28Z",
_20
"url": "https://intelligence.twilio.com/v2/OperatorTypes/EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_20
}


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

This endpoint lists all available Operator Types for an Account.

Property nameTypeRequiredPIIDescription
PageSizeintegerOptional

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

Minimum: 1Maximum: 1000

PageintegerOptional

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

Minimum: 0

PageTokenstringOptional

The page token. This is provided by the API.

List multiple OperatorTypes

list-multiple-operatortypes page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_14
// Download the helper library from https://www.twilio.com/docs/node/install
_14
import twilio from "twilio";
_14
_14
// Find your Account SID and Auth Token at twilio.com/console
_14
// and set the environment variables. See http://twil.io/secure
_14
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_14
const authToken = process.env.TWILIO_AUTH_TOKEN;
_14
const client = twilio(accountSid, authToken);
_14
_14
const operatorTypes = await client.intelligence.v2.operatorType.list({
_14
limit: 20,
_14
});
_14
_14
operatorTypes.forEach((o) => console.log(o.name));

Output

_33
{
_33
"operator_types": [
_33
{
_33
"name": "Summarization",
_33
"sid": "EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_33
"friendly_name": "Summarize Conversations",
_33
"description": "Summarize Conversations",
_33
"docs_link": "/docs/voice/intelligence/key-concepts#language-operators",
_33
"output_type": "text-generation",
_33
"supported_languages": [
_33
"en"
_33
],
_33
"provider": "openai",
_33
"availability": "public",
_33
"configurable": true,
_33
"config_schema": {
_33
"field": "value"
_33
},
_33
"date_created": "2010-08-31T20:36:28Z",
_33
"date_updated": "2010-08-31T20:36:28Z",
_33
"url": "https://intelligence.twilio.com/v2/OperatorTypes/EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_33
}
_33
],
_33
"meta": {
_33
"first_page_url": "https://intelligence.twilio.com/v2/OperatorTypes?PageSize=50&Page=0",
_33
"key": "operator_types",
_33
"next_page_url": null,
_33
"page": 0,
_33
"page_size": 50,
_33
"previous_page_url": null,
_33
"url": "https://intelligence.twilio.com/v2/OperatorTypes?PageSize=50&Page=0"
_33
}
_33
}


Rate this page: