TTS Voice Object
The TTS Voice object defines a single voice profile available for text-to-speech synthesis. Each voice has a unique identifier, a group that specifies its source (internal CarrierX or external Amazon Polly), and a list of supported languages with corresponding priority values.
This object allows partners to discover which voices are available for use, determine the languages each voice supports, and reference the correct voice_sid when creating TTS recordings.
TTS voices are grouped into:
- Internal voices (man, woman) — provided by CarrierX.
- External voices — sourced from Amazon Polly.
Refer to the Amazon Polly Voices section for the complete list of available voices and their supported languages.
TTS Voice Object Attributes
The fields listed in the table below will be returned in a JSON object when a successful request has been made.
| Attribute | Data Type | Description |
|---|---|---|
| languages read only | object | The languages that the voice supports with the voice priority in scope of the language. Smaller values have higher priority. |
| voice_sid read only | string | The voice secure ID. Refer to this table for the complete list of the available voices. |
Sample TTS Voice Object
{
"languages": {
"en-US": 0
},
"voice_sid": "Polly.Joanna"
}