| Name | Type | Description | Notes |
|---|---|---|---|
| payload | String | The text or SSML to be converted into speech. There is a 3,000 character limit. | |
| invalidPayload | String | The text or SSML to be converted into speech when digits don't match the `valid_digits` parameter or the number of digits is not between `min` and `max`. There is a 3,000 character limit. | [optional] |
| payloadType | PayloadTypeEnum | The type of the provided payload. The payload can either be plain text, or Speech Synthesis Markup Language (SSML). | [optional] |
| serviceLevel | ServiceLevelEnum | This parameter impacts speech quality, language options and payload types. When using `basic`, only the `en-US` language and payload type `text` are allowed. | [optional] |
| voice | VoiceEnum | The gender of the voice used to speak back the text or the specific Amazon Polly voice to be used in the form of `Polly.<voice>`, e.g. `Polly.Brian`. All standard Amazon Polly voices are supported. | |
| language | LanguageEnum | The language you want spoken. This parameter is ignored when a `Polly.*` voice is specified. | [optional] |
| minimumDigits | Integer | The minimum number of digits to fetch. This parameter has a minimum value of 1. | [optional] |
| maximumDigits | Integer | The maximum number of digits to fetch. This parameter has a maximum value of 128. | [optional] |
| maximumTries | Integer | The maximum number of times that a file should be played back if there is no input from the user on the call. | [optional] |
| timeoutMillis | Integer | The number of milliseconds to wait for a DTMF response after speak ends before a replaying the sound file. | [optional] |
| terminatingDigit | String | The digit used to terminate input if fewer than `maximum_digits` digits have been gathered. | [optional] |
| validDigits | String | A list of all digits accepted as valid. | [optional] |
| interDigitTimeoutMillis | Integer | The number of milliseconds to wait for input between digits. | [optional] |
| clientState | String | Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. | [optional] |
| commandId | String | Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. | [optional] |
| Name | Value |
|---|---|
| TEXT | "text" |
| SSML | "ssml" |
| Name | Value |
|---|---|
| BASIC | "basic" |
| PREMIUM | "premium" |
| Name | Value |
|---|---|
| MALE | "male" |
| FEMALE | "female" |
| Name | Value |
|---|---|
| ARB | "arb" |
| CMN_CN | "cmn-CN" |
| CY_GB | "cy-GB" |
| DA_DK | "da-DK" |
| DE_DE | "de-DE" |
| EN_AU | "en-AU" |
| EN_GB | "en-GB" |
| EN_GB_WLS | "en-GB-WLS" |
| EN_IN | "en-IN" |
| EN_US | "en-US" |
| ES_ES | "es-ES" |
| ES_MX | "es-MX" |
| ES_US | "es-US" |
| FR_CA | "fr-CA" |
| FR_FR | "fr-FR" |
| HI_IN | "hi-IN" |
| IS_IS | "is-IS" |
| IT_IT | "it-IT" |
| JA_JP | "ja-JP" |
| KO_KR | "ko-KR" |
| NB_NO | "nb-NO" |
| NL_NL | "nl-NL" |
| PL_PL | "pl-PL" |
| PT_BR | "pt-BR" |
| PT_PT | "pt-PT" |
| RO_RO | "ro-RO" |
| RU_RU | "ru-RU" |
| SV_SE | "sv-SE" |
| TR_TR | "tr-TR" |