Conversational Intelligence - CustomOperator Subresource

The CustomOperator subresource of the Operator resource represents a Custom Operator. A Custom Operator refers to a Language Operator you have created on your Account.

Custom Operator Properties

Property nameTypeRequiredPIIDescriptionChild properties

accountSidSID<AC>

Optional

Not PII

The unique SID identifier of the Account the Custom 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 Custom Operator.

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

friendlyNamestring

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 Custom Operator. Custom Operators can only be created by a Twilio Account.

operatorTypestring

Optional

Not PII

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

versioninteger

Optional

Not PII

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

Default: 0

availabilityenum<string>

Optional

Not PII

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

Possible values:

internalbetapublicretired

config

Optional

Not PII

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

dateCreatedstring<date-time>

Optional

Not PII

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

dateUpdatedstring<date-time>

Optional

Not PII

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

urlstring<uri>

Optional

Not PII

The URL of this resource.

Create a Custom Operator

POST https://intelligence.twilio.com/v2/Operators/Custom

This endpoint allows you to create a new Custom Operator for an Intelligence Service on your Account. Currently, you can create Custom Operators of the LiteralSpot or LiteralClassification Operator Types. LiteralSpot lets you find and extract useful phrases in a Transcript while LiteralClassification lets you categorize an entire Transcript or sentences within a Transcript.

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

friendlyNamestring

required

Not PII

A human readable description of the new Operator, up to 64 characters.

operatorTypestring

required

Not PII

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

config

required

Not PII

Operator configuration, following the schema defined by the Operator Type.

First, identify the Operator Type of the new Custom Operator. You can fetch a list of available Operator Types using the OperatorType resource. The Operator Type you choose must have the configurable property set to true.

OperatorType parameter

When creating your Custom Operator, use the Operator Type's name as the value for the OperatorType parameter.

Config parameter

Review the Operator Type's config_schema property (specifically the required and properties fields) to set the Config parameter.

Create a Custom 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 createCustomOperator() {
11  const customOperator = await client.intelligence.v2.customOperators.create({
12    config: {},
13    friendlyName: "FriendlyName",
14    operatorType: "OperatorType",
15  });
16
17  console.log(customOperator.accountSid);
18}
19
20createCustomOperator();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "FriendlyName",
5  "description": "New Operator",
6  "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7  "operator_type": "OperatorType",
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/Custom/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
18}

Fetch a Custom Operator

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

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

Path parameters

Property nameTypeRequiredPIIDescription

sidSID<LY>

required

Not PII

A 34 character string that uniquely identifies this Custom Operator.

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

Fetch a Custom 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 fetchCustomOperator() {
11  const customOperator = await client.intelligence.v2
12    .customOperators("LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .fetch();
14
15  console.log(customOperator.accountSid);
16}
17
18fetchCustomOperator();

Response

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

List Custom Operators

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

This endpoint lists all available Custom Operators you can add to Intelligence Services on your Account, with optional filtering.

Query parameters

Property nameTypeRequiredPIIDescription

availabilityenum<string>

Optional

Not PII

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

Possible values:

internalbetapublicretired

languageCodestring

Optional

Not PII

Returns Custom Operators that support the provided language code.

pageSizeinteger<int64>

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

Response

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

Update a Custom Operator

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

This endpoint updates a Custom Operator.

Headers

Property nameTypeRequiredPIIDescription

if-Matchstring

Optional

Not PII

The If-Match HTTP request header

Path parameters

Property nameTypeRequiredPIIDescription

sidSID<LY>

required

Not PII

A 34 character string that uniquely identifies this Custom Operator.

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

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

friendlyNamestring

required

Not PII

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

config

required

Not PII

Operator configuration, following the schema defined by the Operator Type.

Update a Custom 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 updateCustomOperator() {
11  const customOperator = await client.intelligence.v2
12    .customOperators("LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .update({
14      config: {},
15      friendlyName: "FriendlyName",
16    });
17
18  console.log(customOperator.accountSid);
19}
20
21updateCustomOperator();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "FriendlyName",
5  "description": "My New Operator",
6  "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7  "operator_type": "operator-type-name",
8  "version": 2,
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/Custom/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
18}

Delete a Custom Operator

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

This endpoint deletes a Custom Operator.

Path parameters

Property nameTypeRequiredPIIDescription

sidSID<LY>

required

Not PII

A 34 character string that uniquely identifies this Custom Operator.

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

Delete a Custom 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 deleteCustomOperator() {
11  await client.intelligence.v2
12    .customOperators("LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .remove();
14}
15
16deleteCustomOperator();