Service Resource
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.
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
| Resource Properties in REST API format | |
|---|---|
account_sid
|
The unique SID identifier of the Account the Service belongs to. |
auto_redaction
|
Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service. |
media_redaction
|
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_transcribe
|
Instructs the Speech Recognition service to automatically transcribe all recordings made on the account. |
data_logging
|
Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models. |
date_created
|
The date that this Service was created, given in ISO 8601 format. |
date_updated
|
The date that this Service was updated, given in ISO 8601 format. |
friendly_name
|
A human readable description of this resource, up to 64 characters. |
language_code
|
The default language code of the audio. |
sid
|
A 34 character string that uniquely identifies this Service. |
unique_name
|
Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID. |
url
|
The URL of this resource. |
webhook_url
|
The URL Twilio will request when executing the Webhook. |
webhook_http_method
|
The HTTP method for the Webhook. One of |
version
|
The version number of this Service. |
Automatically analyze all Twilio call recordings in your account
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.
PII redaction
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.
If you change the PII redaction or auto-transcribe setting on a Service, it can take up to 10 minutes to come into effect.
Create a Service
https://intelligence.twilio.com/v2/Services
Parameters
| Parameters in REST API format | |
|---|---|
unique_name
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. |
auto_transcribe
Optional
|
Instructs the Speech Recognition service to automatically transcribe all recordings made on the account. |
data_logging
Optional
|
Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models. |
friendly_name
Optional
|
A human readable description of this resource, up to 64 characters. |
language_code
Optional
|
The default language code of the audio. |
auto_redaction
Optional
|
Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service. |
media_redaction
Optional
|
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. |
webhook_url
Optional
|
The URL Twilio will request when executing the Webhook. |
webhook_http_method
Optional
|
The HTTP method for the Webhook. One of |
Example 1
Fetch a Service
https://intelligence.twilio.com/v2/Services/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
A 34 character string that uniquely identifies this Service. |
Example 1
Fetch Multiple Services
https://intelligence.twilio.com/v2/Services
Example 1
Update a Service
https://intelligence.twilio.com/v2/Services/{Sid}
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.
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
A 34 character string that uniquely identifies this Service. |
auto_transcribe
Optional
|
Instructs the Speech Recognition service to automatically transcribe all recordings made on the account. |
data_logging
Optional
|
Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models. |
friendly_name
Optional
|
A human readable description of this resource, up to 64 characters. |
language_code
Optional
|
The default language code of the audio. |
unique_name
Optional
|
Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID. |
auto_redaction
Optional
|
Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service. |
media_redaction
Optional
|
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. |
webhook_url
Optional
|
The URL Twilio will request when executing the Webhook. |
webhook_http_method
Optional
|
The HTTP method for the Webhook. One of |
if_match
Header
|
The If-Match HTTP request header |
Example 1
Delete a Service
https://intelligence.twilio.com/v2/Services/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
A 34 character string that uniquely identifies this Service. |
