This action should be used to play a text to speech message and capture user inputs.
The following is an example of the JSON response you would need to provide:
{
"clientActionId": "VoiceIvrId1",
"callflow": [
{
"action": "say&capture",
"params": {
"text": "Hello, please input your 6 digit verification number",
"language": "en-US",
"voiceProfile": "en-US-Salli",
"repetition": 1,
"minDigits": 6
}
}
]
}
The action should contain the following parameters:
| Name | Type | Description |
|---|---|---|
| action | String | say&capture – Action to play an TTS message and capture user inputs |
| text | String | The text to speech message that will be played on the call |
| language | String | The language code of the spoken text, see in the table above the supported languages |
| voiceProfile | Boolean | The voice profile of the spoken text, see in the table above the supported voice profiles |
| repetition | Integer | Defines the number of times the text will be repeated during the call. |
| minDigits | Integer | (Optional) Minimum number of dial-pad inputs that the calling user can make. Accepted values are from 1 to 20. |
Please note that If dtmfInterrupt is used, dtmfLength is also required. The calling user's dial-pad inputs will be provided to you in the Call Handle dtmf key.
Supported TTS Voice Profile(s) and language(s) are:
| Language | Language code | Voice profile |
|---|---|---|
| Arabic Egypt | ar-EG | ar-EG-Hoda |
| Arabic Egypt | ar-EG | ar-EG-SalmaNeural |
| Arabic Egypt | ar-EG | ar-EG-ShakirNeural |
| Arabic Saudi Arabia | ar-SA | ar-SA-Naayf |
| Arabic Saudi Arabia | ar-SA | ar-SA-Naayf |
| Arabic Saudi Arabia | ar-SA | ar-SA-HamedNeural |
| Arabic Saudi Arabia | ar-SA | ar-SA-ZariyahNeural |
| Bulgarian - Bulgaria | bg-BG | bg-BG-Ivan |
| Bulgarian - Bulgaria | bg-BG | bg-BG-BorislavNeural |
| Catalan - Catalan | ca-ES | ca-ES-AlbaNeural |
| Catalan - Catalan | ca-ES | ca-ES-EnricNeural |
| Catalan - Catalan | ca-ES | ca-ES-HerenaRUS |
| Catalan - Catalan | ca-ES | ca-ES-JoanaNeural |
| Chinese (Taiwanese) - Taiwan | zh-TW | zh-TW-HsiaoChenNeural |
| Chinese (Taiwanese) - Taiwan | zh-TW | zh-TW-HsiaoYuNeural |
| Chinese (Taiwanese) - Taiwan | zh-TW | zh-TW-Yating |
| Chinese (Taiwanese) - Taiwan | zh-TW | zh-TW-YunJheNeural |
| Chinese (Taiwanese) - Taiwan | zh-TW | zh-TW-Zhiwei |
| Chinese (Mandarin) - China | zh-CN | zh-CN-Yaoyao-Apollo |
| Chinese (Mandarin) - China | zh-CN | zh-CN-Kangkang |
| Chinese (Mandarin) - China | zh-CN | zh-CN-XiaohanNeural |
| Chinese (Mandarin) - China | zh-CN | zh-CN-XiaoxiaoNeural |
| Chinese (Mandarin) - China | zh-CN | zh-CN-XiaoxuanNeural |
| Chinese (Mandarin) - China | zh-CN | zh-CN-XiaoyouNeural |
| Chinese (Mandarin) - China | zh-CN | zh-CN-Yaoyao |
| Chinese (Mandarin) - China | zh-CN | zh-CN-YunxiNeural |
| Chinese (Mandarin) - China | zh-CN | zh-CN-YunyangNeural |
| Chinese (Mandarin) - China | zh-CN | zh-CN-YunyeNeural |
| Chinese (Mandarin) - China | zh-CN | zh-CN-XiaomoNeural |
| Chinese (Mandarin) - China | zh-CN | zh-CN-XiaoruiNeural |
| Chinese (Mandarin) - China | zh-CN | zh-CN-HuihuiRUS |
| Chinese (Mandarin) - China | zh-CN | zh-CN-Kangkang-Apollo |
| Chinese (Cantonese) - China | zh-HK | zh-HK-Danny |
| Chinese (Cantonese) - China | zh-HK | zh-HK-HiuGaaiNeural |
| Chinese (Cantonese) - China | zh-HK | zh-HK-HiuMaanNeural |
| Chinese (Cantonese) - China | zh-HK | zh-HK-WanLungNeural |
| Chinese (Cantonese) - China | zh-HK | zh-HK-Danny-Apollo |
| Chinese (Cantonese) - China | zh-HK | zh-HK-Tracy-Apollo |
| Chinese (Cantonese) - China | zh-HK | zh-HK-TracyRUS |
| Croatian - Croatia | hr-HR | hr-HR-Matej |
| Croatian - Croatia | hr-HR | pt-BR-Daniel |
| Croatian - Croatia | hr-HR | hr-HR-GabrijelaNeural |
| Croatian - Croatia | hr-HR | hr-HR-SreckoNeural |
| Czech - Czech Republic | cs-CZ | cs-CZ-AntoninNeural |
| Czech - Czech Republic | cs-CZ | cs-CZ-VlastaNeural |
| Czech - Czech Republic | cs-CZ | cs-CZ-Jakub |
| Danish - Denmark | da-DK | da-DK-ChristelNeural |
| Danish - Denmark | da-DK | da-DK-JeppeNeural |
| Danish - Denmark | da-DK | da-DK-HelleRUS |
| Danish - Denmark | da-DK | da-DK-Mads |
| Danish - Denmark | da-DK | da-DK-Naja |
| Dutch - Netherlands | nl-NL | nl-NL-ColetteNeural |
| Dutch - Netherlands | nl-NL | nl-NL-FennaNeural |
| Dutch - Netherlands | nl-NL | nl-NL-MaartenNeural |
| Dutch - Netherlands | nl-NL | nl-NL-HannaRUS |
| Dutch - Netherlands | nl-NL | nl-NL-Lotte |
| dutch - Netherlands | nl-NL | nl-NL-Ruben |
| English - Australia | en-AU | en-AU-Catherine |
| English - Australia | en-AU | en-AU-HayleyRUS |
| English - Australia | en-AU | en-AU-Nicole |
| English - Australia | en-AU | en-AU-Russell |
| English - Australia | en-AU | en-AU-NatashaNeural |
| English - Australia | en-AU | en-AU-WilliamNeural |
| English - Canada | en-CA | en-CA-HeatherRUS |
| English - Canada | en-CA | en-CA-Linda |
| English - Canada | en-CA | en-CA-ClaraNeural |
| English - Canada | en-CA | en-CA-LiamNeural |
| English - India | en-IN | en-IN-Aditi |
| English - India | en-IN | en-IN-Heera-Apollo |
| English - India | en-IN | en-IN-PriyaRUS |
| English - India | en-IN | en-IN-Raveena |
| English - India | en-IN | en-IN-Ravi-Apollo |
| English - India | en-IN | en-IN-Heera |
| English - India | en-IN | en-IN-PrabhatNeural |
| English - India | en-IN | en-IN-Ravi |
| English - Ireland | en-IE | en-IE-Sean |
| English - Ireland | en-IE | en-IE-ConnorNeural |
| English - Ireland | en-IE | en-IE-EmilyNeural |
| English - United Kingdom | en-GB | en-GB-WLS-Geraint |
| English - United Kingdom | en-GB | en-GB-Brian |
| English - United Kingdom | en-GB | en-GB-Emma |
| English - United Kingdom | en-GB | en-GB-George-Apollo |
| English - United Kingdom | en-GB | en-GB-HazelRUS |
| English - United Kingdom | en-GB | en-GB-Susan-Apollo |
| English - United Kingdom | en-GB | en-GB-George |
| English - United Kingdom | en-GB | en-GB-LibbyNeural |
| English - United Kingdom | en-GB | en-GB-MiaNeural |
| English - United Kingdom | en-GB | en-GB-RyanNeural |
| English - United Kingdom | en-GB | en-GB-Susan |
| English - United States | en-US | en-US-AriaRUS |
| English - United States | en-US | en-US-BenjaminRUS |
| English - United States | en-US | en-US-Guy24kRUS |
| English - United States | en-US | en-US-Ivy |
| English - United States | en-US | en-US-Joanna |
| English - United States | en-US | en-US-Joey |
| English - United States | en-US | en-US-Justin |
| English - United States | en-US | en-US-Kendra |
| English - United States | en-US | en-US-Kimberly |
| English - United States | en-US | en-US-Matthew |
| English - United States | en-US | en-US-Salli |
| English - United States | en-US | en-US-ZiraRUS |
| English - United States | en-US | en-US-AriaNeural |
| English - United States | en-uS | en-US-GuyNeural |
| English - United States | en-uS | en-US-GuyRUS |
| English - United States | en-US | en-US-JennyNeural |
| Estonian - Estonien | et-EE | et-EE-AnuNeural |
| Estonian - Estonien | et-EE | et-EE-KertNeural |
| Filipino (Philippines) | fil-PH | fil-PH-AngeloNeural |
| Filipino (Philippines) | fil-PH | fil-PH-BlessicaNeural |
| Finnish - Finland | fi-FI | fi-FI-HeidiRUS |
| Finnish - Finland | fI-FI | fi-FI-HarriNeural |
| Finnish - Finland | fI-FI | fi-FI-NooraNeural |
| Finnish - Finland | fi-FI | fi-FI-SelmaNeural |
| French - Canada | fr-CA | fr-CA-Caroline |
| French - Canada | fr-CA | fr-CA-Chantal |
| French - Canada | fr-CA | fr-CA-HarmonieRUS |
| French - Canada | fr-CA | fr-CA-JeanNeural |
| French - Canada | fr-CA | fr-CA-SylvieNeural |
| French - France | fr-FR | fr-FR-Celine |
| French - France | fr-FR | fr-FR-HortenseRUS |
| French - France | fr-FR | fr-FR-Julie-Apollo |
| French - France | fr-FR | fr-FR-Mathieu |
| French - France | fr-FR | fr-FR-Paul-Apollo |
| French - France | fr-FR | fr-FR-HenriNeural |
| French - France | fr-FR | fr-FR-Julie |
| French - France | fr-FR | fr-FR-Paul |
| French - France | fr-FR | fr-FR-DeniseNeural |
| French - Switzerland | fr-CH | fr-CH-Guillaume |
| French - Switzerland | fr-CH | en-IN-NeerjaNeural |
| French - Switzerland | fr-CH | fr-CH-ArianeNeural |
| French - Switzerland | fr-CH | fr-CH-FabriceNeural |
| German - Austria | de-AT | de-AT-IngridNeural |
| German - Austria | de-AT | de-AT-JonasNeural |
| German - Austria | de-AT | de-AT-Michael |
| German - Germany | de-DE | de-DE-ConradNeural |
| German - Germany | de-DE | de-DE-KatjaNeural |
| German - Germany | de-DE | de-DE-Stefan |
| German - Germany | de-DE | de-DE-Hans |
| German - Germany | de-DE | de-DE-Hedda |
| German - Germany | de-DE | de-DE-HeddaRUS |
| German - Germany | de-DE | de-DE-Marlene |
| German - Germany | de-DE | de-DE-Stefan-Apollo |
| German - Germany | de-DE | de-DE-Vicki |
| German - Switzerland | de-CH | de-CH-JanNeural |
| German - Switzerland | de-CH | de-CH-LeniNeural |
| German - Switzerland | de-CH | de-CH-Karsten |
| Greek - Greece | el-GR | el-GR-AthinaNeural |
| Greek - Greece | el-GR | el-GR-NestorasNeural |
| Greek - Greece | el-GR | el-GR-Stefanos |
| Hebrew - Israel | he-IL | he-IL-Asaf |
| Hebrew - Israel | he-IL | he-IL-AvriNeural |
| Hebrew - Israel | he-IL | he-IL-HilaNeural |
| Hindi - India | hi-IN | hi-IN-Hemant |
| Hindi - India | hi-IN | hi-IN-Kalpana |
| Hindi - India | hi-IN | hi-IN-Kalpana-Apollo |
| Hindi - India | hi-IN | hi-IN-MadhurNeural |
| Hindi - India | hi-IN | hi-IN-SwaraNeural |
| Hungarian - Hungary | hu-HU | hu-HU-Szabolcs |
| Hungarian - Hungary | hu-HU | hu-HU-NoemiNeural |
| Hungarian - Hungary | hu-HU | hu-HU-TamasNeural |
| Icelandic - Iceland | is-IS | is-IS-Dora |
| Icelandic - Iceland | is-IS | is-IS-Karl |
| Indonesian - Indonesia | id-ID | id-ID-Andika |
| Indonesian - Indonesia | id-ID | id-ID-ArdiNeural |
| Indonesian - Indonesia | id-ID | id-ID-GadisNeural |
| Irish - Gaelic | ga-IE | ga-IE-ColmNeural |
| Irish - Gaelic | ga-IE | ga-IE-OrlaNeural |
| Italian - Italy | it-IT | lt-LT-LeonasNeural |
| italian - Italy | it-IT | lt-LT-OnaNeural |
| Italian - Italy | it-IT | it-IT-Carla |
| Italian - Italy | it-IT | it-IT-Cosimo-Apollo |
| Italian - Italy | it-IT | it-IT-Giorgio |
| Italian - Italy | it-IT | it-IT-LuciaRUS |
| Italian - Italy | it-IT | it-IT-Cosimo |
| Italian - Italy | it-IT | it-IT-DiegoNeural |
| Italian - Italy | it-IT | it-IT-ElsaNeural |
| Italian - Italy | it-IT | it-IT-IsabellaNeural |
| Italian - Italy | it-IT | it-IT-LuciaRUS |
| Japanese - Japan | ja-JP | ja-JP-KeitaNeural |
| Japanese - Japan | ja-JP | ja-JP-NanamiNeural |
| Japanese - Japan | ja-JP | ja-JP-Ayumi-Apollo |
| Japanese - Japan | ja-JP | ja-JP-HarukaRUS |
| Japanese - Japan | ja-JP | ja-JP-Ichiro-Apollo |
| Japanese - Japan | ja-JP | ja-JP-Mizuki |
| Japanese - Japan | ja-JP | ja-JP-Takumi |
| Japanese - Japan | ja-JP | ja-JP-Ayumi |
| Japanese - Japan | ja-JP | ja-JP-Ichiro |
| Korean - Korea | ko-KR | ko-KR-InJoonNeural |
| Korean - Korea | ko-KR | ko-KR-SunHiNeural |
| Korean - Korea | ko-KR | ko-KR-HeamiRUS |
| Korean - Korea | ko-KR | ko-KR-Seoyeon |
| Latvian - Latvia | lv-LV | lv-LV-EveritaNeural |
| Latvian - Latvia | lv-LV | lv-LV-NilsNeural |
| Malay - Malaysia | ms-MY | ms-MY-OsmanNeural |
| Malay - Malaysia | ms-MY | ms-MY-YasminNeural |
| Malay - Malaysia | ms-MY | ms-MY-Rizwan |
| Maltese - Malta | mt-MT | mt-MT-GraceNeural |
| Maltese - Malta | mt-MT | mt-MT-JosephNeural |
| Norwegian (Bokm) - Norway | nb-NO | nb-NO-IselinNeural |
| Norwegian (Bokm) - Norway | nb-NO | nb-NO-PernilleNeural |
| Norwegian (Bokm) - Norway | nb-NO | nb-NO-FinnNeural |
| Norwegian (Bokm) - Norway | nb-NO | nb-NO-HuldaRUS |
| Norwegian (Bokm) - Norway | nb-NO | nb-NO-Liv |
| Polish - Poland | pl-PL | pl-PL-ZofiaNeural |
| Polish - Poland | pl-PL | pl-PL-AgnieszkaNeural |
| Polish - Poland | pl-PL | pl-PL-MarekNeural |
| Polish - Poland | pl-PL | pl-PL-Ewa |
| Polish - Poland | pl-PL | pl-PL-Jacek |
| Polish - Poland | pl-PL | pl-PL-Jan |
| Polish - Poland | pl-PL | pl-PL-Maja |
| Polish - Poland | pl-PL | pl-PL-PaulinaRUS |
| Portuguese - Brazil | pt-BR | pt-BR-AntonioNeural |
| Portuguese - Brazil | pt-BR | pt-BR-FranciscaNeural |
| Portuguese - Brazil | pt-BR | pt-BR-Daniel-Apollo |
| Portuguese - Brazil | pt-BR | pt-BR-HeloisaRUS |
| Portuguese - Brazil | pt-BR | pt-BR-Ricardo |
| Portuguese - Brazil | pt-BR | pt-BR-Vitoria |
| Portuguese - Portugal | pt-PT | pt-PT-DuarteNeural |
| Portuguese - Portugal | pt-PT | pt-PT-FernandaNeural |
| Portuguese - Portugal | pt-PT | pt-PT-RaquelNeural |
| Portuguese - Portugal | pt-PT | pt-PT-Cristiano |
| Portuguese - Portugal | pt-PT | pt-PT-HeliaRUS |
| Portuguese - Portugal | pt-PT | pt-PT-Ines |
| Romanian - Romania | ro-RO | ro-RO-AlinaNeural |
| Romanian - Romania | ro-RO | ro-RO-EmilNeural |
| Romanian - Romania | ro-RO | ro-RO-Andrei |
| Romanian - Romania | ro-RO | ro-RO-Carmen |
| Russian - Russia | ru-RU | ru-RU-DariyaNeural |
| Russian - Russia | ru-RU | ru-RU-DmitryNeural |
| Russian - Russia | ru-RU | ru-RU-Irina |
| Russian - Russia | ru-RU | ru-RU-Pavel |
| Russian - Russia | ru-RU | ru-RU-SvetlanaNeural |
| Russian - Russia | ru-RU | ru-RU-EkaterinaRUS |
| Russian - Russia | ru-RU | ru-RU-Irina-Apollo |
| Russian - Russia | ru-RU | ru-RU-Maxim |
| Russian - Russia | ru-RU | ru-RU-Pavel-Apollo |
| Russian - Russia | ru-RU | ru-RU-Tatyana |
| Slovak - Slovakia | sk-SK | sk-SK-LukasNeural |
| slovak - Slovakia | sk-SK | sk-SK-ViktoriaNeural |
| Slovak - Slovakia | sl-SI | sl-SI-PetraNeural |
| Slovak - Slovakia | sl-SI | sl-SI-RokNeural |
| Slovak - Slovakia | sk-SK | sk-SK-Filip |
| Slovenian - Slovenia | sl-SI | sl-SI-Lado |
| Spanish - Mexico | es-MX | es-MX-DaliaNeural |
| Spanish - Mexico | es-MX | es-MX-JorgeNeural |
| Spanish - Mexico | es-MX | es-MX-Raul |
| Spanish - Mexico | es-MX | es-MX-HildaRUS |
| Spanish - Mexico | es-MX | es-MX-Raul-Apollo |
| Spanish - Spain | es-ES | es-ES-AlvaroNeural |
| Spanish - Spain | es-ES | es-ES-ElviraNeural |
| spanish - Spain | es-ES | es-ES-Laura |
| Spanish - Spain | es-ES | es-ES-Pablo |
| Spanish - Spain | es-ES | es-ES-Conchita |
| Spanish - Spain | es-ES | es-ES-Enrique |
| Spanish - Spain | es-ES | es-ES-HelenaRUS |
| Spanish - Spain | es-ES | es-ES-Laura-Apollo |
| Spanish - Spain | es-ES | es-ES-Pablo-Apollo |
| Spanish - United States | es-US | es-US-Miguel |
| Spanish - United States | es-US | es-US-Penelope |
| Swedish - Sweden | sv-SE | sv-SE-HilleviNeural |
| Swedish - Sweden | sv-SE | sv-SE-MattiasNeural |
| Swedish - Sweden | sv-SE | sv-SE-SofieNeural |
| Swedish - Sweden | sv-SE | sv-SE-Astrid |
| Swedish - Sweden | sv-SE | sv-SE-HedvigRUS |
| Taiwanese - Taiwan | zh-TW | zh-TW-HanHanRUS |
| Taiwanese - Taiwan | zh-TW | zh-TW-Yating-Apollo |
| Taiwanese - Taiwan | zh-TW | zh-TW-Zhiwei-Apollo |
| Tamil - India | ta-IN | ta-IN-PallaviNeural |
| Tamil - India | ta-IN | ta-IN-ValluvarNeural |
| Tamil - India | ta-IN | ta-IN-Valluvar |
| Telugu - India | te-IN | te-IN-MohanNeural |
| Telugu - India | te-IN | te-IN-ShrutiNeural |
| Telugu - India | te-IN | te-IN-Chitra |
| Thai - Thailand | th-TH | th-TH-AcharaNeural |
| Thai - Thailand | th-TH | th-TH-NiwatNeural |
| Thai - Thailand | th-TH | th-TH-PremwadeeNeural |
| Thai - Thailand | th-TH | th-TH-Pattara |
| Turkish - Turkey | tr-TR | tr-TR-AhmetNeural |
| Turkish - Turkey | tr-TR | tr-TR-EmelNeural |
| Turkish - Turkey | tr-TR | tr-TR-Filiz |
| Turkish - Turkey | tr-TR | tr-TR-SedaRUS |
| Vietnamese - Vietnam | vi-VN | vi-VN-HoaiMyNeural |
| Vietnamese - Vietnam | vi-VN | vi-VN-NamMinhNeural |
| Vietnamese - Vietnam | vi-VN | vi-VN-An |
| Welsh - United Kingdom | cy-GB | cy-GB-Gwyneth |