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

Service Resource


(warning)

Warning

Public Beta

Voice Intelligence is currently available as a public beta release. Some features are not yet implemented and others may be changed before the product is declared as Generally Available. Beta products are not covered by a Twilio SLA.

Learn more about beta product support(link takes you to an external page).

A Service provides control and configuration for how Transcripts are processed. Any Transcript created belongs to a particular Service and inherits its configuration.

The Service-level configuration includes features like data logging, auto-transcribe, and auto-redaction. Language Operator deployments to a Service are handled through the Twilio Console.


Service Properties

service-properties page anchor
Resource properties
account_sidtype: SID<AC>Not PII

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


auto_redactiontype: booleanNot PII

Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.


media_redactiontype: booleanNot PII

Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.


auto_transcribetype: booleanNot PII

Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.


data_loggingtype: booleanNot PII

Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.


date_createdtype: string<DATE TIME>Not PII

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


date_updatedtype: string<DATE TIME>Not PII

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


friendly_nametype: stringNot PII

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


language_codetype: stringNot PII

The default language code of the audio.


sidtype: stringNot PII

A 34 character string that uniquely identifies this Service.


unique_nametype: stringNot PII

Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.


urltype: string<URI>Not PII

The URL of this resource.


webhook_urltype: stringNot PII

The URL Twilio will request when executing the Webhook.


webhook_http_methodtype: enum<STRING>Not PII

The HTTP method for the Webhook. One of GET or POST.

Possible values:
GETPOSTNULL

versiontype: integerNot PII

The version number of this Service.


Automatically analyze all Twilio call recordings in your account

automatically-analyze-all-twilio-call-recordings-in-your-account page anchor

Enable auto_transcribe if you want to automatically transcribe all Twilio call recordings that are recorded in an account. Auto-transcribe can help you transcribe call recordings without the need of calling the create Transcript Resource. You can enable auto-transcribe through the Service Resource or on the Console, under Service settings.

If you enable auto_transcribe in more than one Service, the call recording will be sent and transcribed more than once, and charged accordingly.


With Voice Intelligence, you can redact Personal Identifiable Information (PII) from your call recording and transcript.

Update your Service with auto_redaction = true to automatically redact PII from all transcripts made on this Service. If you also want to automatically redact PII from all transcripts media sent to the Service, set media_redaction = true.

(warning)

Warning

If you change the PII redaction or auto-transcribe setting on a Service, it can take up to 10 minutes to come into effect.


POST https://intelligence.twilio.com/v2/Services

Parameters

create-parameters page anchor
Request body parameters
UniqueNametype: stringNot PII
Required

Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.


AutoTranscribetype: booleanNot PII

Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.


DataLoggingtype: booleanNot PII

Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.


FriendlyNametype: stringNot PII

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


LanguageCodetype: stringNot PII

The default language code of the audio.


AutoRedactiontype: booleanNot PII

Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.


MediaRedactiontype: booleanNot PII

Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.


WebhookUrltype: stringNot PII

The URL Twilio will request when executing the Webhook.


WebhookHttpMethodtype: enum<STRING>Not PII

The HTTP method for the Webhook. One of GET or POST.

Possible values:
GETPOSTNULL
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.intelligence.v2.services
_10
.create({uniqueName: 'unique_name'})
_10
.then(service => console.log(service.sid));

Output

_17
{
_17
"sid": "GAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"unique_name": "something",
_17
"friendly_name": "some friendly name",
_17
"date_created": "2010-08-31T20:36:28Z",
_17
"date_updated": "2010-08-31T20:36:28Z",
_17
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"auto_redaction": false,
_17
"media_redaction": false,
_17
"auto_transcribe": true,
_17
"data_logging": true,
_17
"language_code": "en-US",
_17
"webhook_url": "https://www.twilio.com",
_17
"webhook_http_method": "POST",
_17
"version": 1,
_17
"url": "https://intelligence.twilio.com/v2/Services/GAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_17
}


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

URI parameters
Sidtype: stringNot PII
Path Parameter

A 34 character string that uniquely identifies this Service.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.intelligence.v2.services('GAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.fetch()
_10
.then(service => console.log(service.friendlyName));

Output

_17
{
_17
"sid": "GAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"unique_name": "something",
_17
"friendly_name": "some friendly name",
_17
"date_created": "2010-08-31T20:36:28Z",
_17
"date_updated": "2010-08-31T20:36:28Z",
_17
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"auto_redaction": false,
_17
"media_redaction": false,
_17
"auto_transcribe": true,
_17
"data_logging": true,
_17
"language_code": "en-US",
_17
"webhook_url": "https://www.twilio.com",
_17
"webhook_http_method": "POST",
_17
"version": 1,
_17
"url": "https://intelligence.twilio.com/v2/Services/GAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_17
}


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

URI parameters
PageSizetype: integerNot PII
Query Parameter

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


Pagetype: integerNot PII
Query Parameter

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


PageTokentype: stringNot PII
Query Parameter

The page token. This is provided by the API.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.intelligence.v2.services
_10
.list({limit: 20})
_10
.then(services => services.forEach(s => console.log(s.sid)));

Output

_30
{
_30
"services": [
_30
{
_30
"sid": "GAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_30
"unique_name": "something",
_30
"friendly_name": "some friendly name",
_30
"date_created": "2010-08-31T20:36:28Z",
_30
"date_updated": "2010-08-31T20:36:28Z",
_30
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_30
"auto_redaction": false,
_30
"media_redaction": false,
_30
"auto_transcribe": true,
_30
"data_logging": true,
_30
"language_code": "en-US",
_30
"webhook_url": "https://www.twilio.com",
_30
"webhook_http_method": "POST",
_30
"version": 1,
_30
"url": "https://intelligence.twilio.com/v2/Services/GAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_30
}
_30
],
_30
"meta": {
_30
"key": "services",
_30
"page": 0,
_30
"page_size": 50,
_30
"first_page_url": "https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0",
_30
"next_page_url": "https://intelligence.twilio.com/v2/Services?PageSize=50&Page=1",
_30
"previous_page_url": "https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0",
_30
"url": "https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0"
_30
}
_30
}


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

(information)

Info

It can take up to 5 minutes to propagate any changes to a Service.

Transcripts generated just after updating parameters like AutoTranscribe, AutoRedaction or MediaRedaction may be generated with the old configuration. After 5 minutes, the newly-created Transcripts will have the new configuration.

Request headers
If-Matchtype: stringNot PII

The If-Match HTTP request header


URI parameters
Sidtype: stringNot PII
Path Parameter

A 34 character string that uniquely identifies this Service.


Request body parameters
AutoTranscribetype: booleanNot PII

Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.


DataLoggingtype: booleanNot PII

Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.


FriendlyNametype: stringNot PII

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


LanguageCodetype: stringNot PII

The default language code of the audio.


UniqueNametype: stringNot PII

Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.


AutoRedactiontype: booleanNot PII

Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.


MediaRedactiontype: booleanNot PII

Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.


WebhookUrltype: stringNot PII

The URL Twilio will request when executing the Webhook.


WebhookHttpMethodtype: enum<STRING>Not PII

The HTTP method for the Webhook. One of GET or POST.

Possible values:
GETPOSTNULL
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.intelligence.v2.services('GAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.update({autoTranscribe: true})
_10
.then(service => console.log(service.friendlyName));

Output

_17
{
_17
"sid": "GAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"unique_name": "something",
_17
"friendly_name": "some friendly name",
_17
"date_created": "2010-08-31T20:36:28Z",
_17
"date_updated": "2010-08-31T20:36:28Z",
_17
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"auto_redaction": false,
_17
"media_redaction": false,
_17
"auto_transcribe": true,
_17
"data_logging": true,
_17
"webhook_url": "https://www.sendgrid.com",
_17
"webhook_http_method": "GET",
_17
"language_code": "en-US",
_17
"version": 2,
_17
"url": "https://intelligence.twilio.com/v2/Services/GAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_17
}


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

URI parameters
Sidtype: stringNot PII
Path Parameter

A 34 character string that uniquely identifies this Service.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.intelligence.v2.services('GAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX').remove();


Rate this page: