Say

This action should be used to play a text to speech message on the call.

The following is an example of the JSON response you would need to provide:

{
  "clientActionId": "VoiceIVRId1",
  "callflow": [
    {
      "action": "say",
      "params": {
        "text": "Hello This is a test message",
        "language": "en-US",
        "voiceProfile": "en-US-Ivy",
        "repetition": 1
      }
    }
  ]
}

The above example would be used if you want the message β€œHello This is a test message” to be pronounced in an English female voice.

The action should contain the following parameters:

NameTypeDescription
actionStringsay – Text to speech function
textStringThe text to speech message that will be played on the call
languageStringThe language of the spoken text, see in the table below of supported languages
voiceProfileStringThe voice profile of the spoken text, see in the table below the supported voice profiles
repetitionIntegerDefines the number of times the text will be repeated during the call.
clientActionIdStringA custom property that you can use to mark individual actions

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:

LanguageLanguage codeVoice profile
Arabic Egyptar-EGar-EG-Hoda
Arabic Egyptar-EGar-EG-SalmaNeural
Arabic Egyptar-EGar-EG-ShakirNeural
Arabic Saudi Arabiaar-SAar-SA-Naayf
Arabic Saudi Arabiaar-SAar-SA-Naayf
Arabic Saudi Arabiaar-SAar-SA-HamedNeural
Arabic Saudi Arabiaar-SAar-SA-ZariyahNeural
Bulgarian - Bulgariabg-BGbg-BG-Ivan
Bulgarian - Bulgariabg-BGbg-BG-BorislavNeural
Catalan - Catalanca-ESca-ES-AlbaNeural
Catalan - Catalanca-ESca-ES-EnricNeural
Catalan - Catalanca-ESca-ES-HerenaRUS
Catalan - Catalanca-ESca-ES-JoanaNeural
Chinese (Taiwanese) - Taiwanzh-TWzh-TW-HsiaoChenNeural
Chinese (Taiwanese) - Taiwanzh-TWzh-TW-HsiaoYuNeural
Chinese (Taiwanese) - Taiwanzh-TWzh-TW-Yating
Chinese (Taiwanese) - Taiwanzh-TWzh-TW-YunJheNeural
Chinese (Taiwanese) - Taiwanzh-TWzh-TW-Zhiwei
Chinese (Mandarin) - Chinazh-CNzh-CN-Yaoyao-Apollo
Chinese (Mandarin) - Chinazh-CNzh-CN-Kangkang
Chinese (Mandarin) - Chinazh-CNzh-CN-XiaohanNeural
Chinese (Mandarin) - Chinazh-CNzh-CN-XiaoxiaoNeural
Chinese (Mandarin) - Chinazh-CNzh-CN-XiaoxuanNeural
Chinese (Mandarin) - Chinazh-CNzh-CN-XiaoyouNeural
Chinese (Mandarin) - Chinazh-CNzh-CN-Yaoyao
Chinese (Mandarin) - Chinazh-CNzh-CN-YunxiNeural
Chinese (Mandarin) - Chinazh-CNzh-CN-YunyangNeural
Chinese (Mandarin) - Chinazh-CNzh-CN-YunyeNeural
Chinese (Mandarin) - Chinazh-CNzh-CN-XiaomoNeural
Chinese (Mandarin) - Chinazh-CNzh-CN-XiaoruiNeural
Chinese (Mandarin) - Chinazh-CNzh-CN-HuihuiRUS
Chinese (Mandarin) - Chinazh-CNzh-CN-Kangkang-Apollo
Chinese (Cantonese) - Chinazh-HKzh-HK-Danny
Chinese (Cantonese) - Chinazh-HKzh-HK-HiuGaaiNeural
Chinese (Cantonese) - Chinazh-HKzh-HK-HiuMaanNeural
Chinese (Cantonese) - Chinazh-HKzh-HK-WanLungNeural
Chinese (Cantonese) - Chinazh-HKzh-HK-Danny-Apollo
Chinese (Cantonese) - Chinazh-HKzh-HK-Tracy-Apollo
Chinese (Cantonese) - Chinazh-HKzh-HK-TracyRUS
Croatian - Croatiahr-HRhr-HR-Matej
Croatian - Croatiahr-HRpt-BR-Daniel
Croatian - Croatiahr-HRhr-HR-GabrijelaNeural
Croatian - Croatiahr-HRhr-HR-SreckoNeural
Czech - Czech Republiccs-CZcs-CZ-AntoninNeural
Czech - Czech Republiccs-CZcs-CZ-VlastaNeural
Czech - Czech Republiccs-CZcs-CZ-Jakub
Danish - Denmarkda-DKda-DK-ChristelNeural
Danish - Denmarkda-DKda-DK-JeppeNeural
Danish - Denmarkda-DKda-DK-HelleRUS
Danish - Denmarkda-DKda-DK-Mads
Danish - Denmarkda-DKda-DK-Naja
Dutch - Netherlandsnl-NLnl-NL-ColetteNeural
Dutch - Netherlandsnl-NLnl-NL-FennaNeural
Dutch - Netherlandsnl-NLnl-NL-MaartenNeural
Dutch - Netherlandsnl-NLnl-NL-HannaRUS
Dutch - Netherlandsnl-NLnl-NL-Lotte
dutch - Netherlandsnl-NLnl-NL-Ruben
English - Australiaen-AUen-AU-Catherine
English - Australiaen-AUen-AU-HayleyRUS
English - Australiaen-AUen-AU-Nicole
English - Australiaen-AUen-AU-Russell
English - Australiaen-AUen-AU-NatashaNeural
English - Australiaen-AUen-AU-WilliamNeural
English - Canadaen-CAen-CA-HeatherRUS
English - Canadaen-CAen-CA-Linda
English - Canadaen-CAen-CA-ClaraNeural
English - Canadaen-CAen-CA-LiamNeural
English - Indiaen-INen-IN-Aditi
English - Indiaen-INen-IN-Heera-Apollo
English - Indiaen-INen-IN-PriyaRUS
English - Indiaen-INen-IN-Raveena
English - Indiaen-INen-IN-Ravi-Apollo
English - Indiaen-INen-IN-Heera
English - Indiaen-INen-IN-PrabhatNeural
English - Indiaen-INen-IN-Ravi
English - Irelanden-IEen-IE-Sean
English - Irelanden-IEen-IE-ConnorNeural
English - Irelanden-IEen-IE-EmilyNeural
English - United Kingdomen-GBen-GB-WLS-Geraint
English - United Kingdomen-GBen-GB-Brian
English - United Kingdomen-GBen-GB-Emma
English - United Kingdomen-GBen-GB-George-Apollo
English - United Kingdomen-GBen-GB-HazelRUS
English - United Kingdomen-GBen-GB-Susan-Apollo
English - United Kingdomen-GBen-GB-George
English - United Kingdomen-GBen-GB-LibbyNeural
English - United Kingdomen-GBen-GB-MiaNeural
English - United Kingdomen-GBen-GB-RyanNeural
English - United Kingdomen-GBen-GB-Susan
English - United Statesen-USen-US-AriaRUS
English - United Statesen-USen-US-BenjaminRUS
English - United Statesen-USen-US-Guy24kRUS
English - United Statesen-USen-US-Ivy
English - United Statesen-USen-US-Joanna
English - United Statesen-USen-US-Joey
English - United Statesen-USen-US-Justin
English - United Statesen-USen-US-Kendra
English - United Statesen-USen-US-Kimberly
English - United Statesen-USen-US-Matthew
English - United Statesen-USen-US-Salli
English - United Statesen-USen-US-ZiraRUS
English - United Statesen-USen-US-AriaNeural
English - United Statesen-uSen-US-GuyNeural
English - United Statesen-uSen-US-GuyRUS
English - United Statesen-USen-US-JennyNeural
Estonian - Estonienet-EEet-EE-AnuNeural
Estonian - Estonienet-EEet-EE-KertNeural
Filipino (Philippines)fil-PHfil-PH-AngeloNeural
Filipino (Philippines)fil-PHfil-PH-BlessicaNeural
Finnish - Finlandfi-FIfi-FI-HeidiRUS
Finnish - FinlandfI-FIfi-FI-HarriNeural
Finnish - FinlandfI-FIfi-FI-NooraNeural
Finnish - Finlandfi-FIfi-FI-SelmaNeural
French - Canadafr-CAfr-CA-Caroline
French - Canadafr-CAfr-CA-Chantal
French - Canadafr-CAfr-CA-HarmonieRUS
French - Canadafr-CAfr-CA-JeanNeural
French - Canadafr-CAfr-CA-SylvieNeural
French - Francefr-FRfr-FR-Celine
French - Francefr-FRfr-FR-HortenseRUS
French - Francefr-FRfr-FR-Julie-Apollo
French - Francefr-FRfr-FR-Mathieu
French - Francefr-FRfr-FR-Paul-Apollo
French - Francefr-FRfr-FR-HenriNeural
French - Francefr-FRfr-FR-Julie
French - Francefr-FRfr-FR-Paul
French - Francefr-FRfr-FR-DeniseNeural
French - Switzerlandfr-CHfr-CH-Guillaume
French - Switzerlandfr-CHen-IN-NeerjaNeural
French - Switzerlandfr-CHfr-CH-ArianeNeural
French - Switzerlandfr-CHfr-CH-FabriceNeural
German - Austriade-ATde-AT-IngridNeural
German - Austriade-ATde-AT-JonasNeural
German - Austriade-ATde-AT-Michael
German - Germanyde-DEde-DE-ConradNeural
German - Germanyde-DEde-DE-KatjaNeural
German - Germanyde-DEde-DE-Stefan
German - Germanyde-DEde-DE-Hans
German - Germanyde-DEde-DE-Hedda
German - Germanyde-DEde-DE-HeddaRUS
German - Germanyde-DEde-DE-Marlene
German - Germanyde-DEde-DE-Stefan-Apollo
German - Germanyde-DEde-DE-Vicki
German - Switzerlandde-CHde-CH-JanNeural
German - Switzerlandde-CHde-CH-LeniNeural
German - Switzerlandde-CHde-CH-Karsten
Greek - Greeceel-GRel-GR-AthinaNeural
Greek - Greeceel-GRel-GR-NestorasNeural
Greek - Greeceel-GRel-GR-Stefanos
Hebrew - Israelhe-ILhe-IL-Asaf
Hebrew - Israelhe-ILhe-IL-AvriNeural
Hebrew - Israelhe-ILhe-IL-HilaNeural
Hindi - Indiahi-INhi-IN-Hemant
Hindi - Indiahi-INhi-IN-Kalpana
Hindi - Indiahi-INhi-IN-Kalpana-Apollo
Hindi - Indiahi-INhi-IN-MadhurNeural
Hindi - Indiahi-INhi-IN-SwaraNeural
Hungarian - Hungaryhu-HUhu-HU-Szabolcs
Hungarian - Hungaryhu-HUhu-HU-NoemiNeural
Hungarian - Hungaryhu-HUhu-HU-TamasNeural
Icelandic - Icelandis-ISis-IS-Dora
Icelandic - Icelandis-ISis-IS-Karl
Indonesian - Indonesiaid-IDid-ID-Andika
Indonesian - Indonesiaid-IDid-ID-ArdiNeural
Indonesian - Indonesiaid-IDid-ID-GadisNeural
Irish - Gaelicga-IEga-IE-ColmNeural
Irish - Gaelicga-IEga-IE-OrlaNeural
Italian - Italyit-ITlt-LT-LeonasNeural
italian - Italyit-ITlt-LT-OnaNeural
Italian - Italyit-ITit-IT-Carla
Italian - Italyit-ITit-IT-Cosimo-Apollo
Italian - Italyit-ITit-IT-Giorgio
Italian - Italyit-ITit-IT-LuciaRUS
Italian - Italyit-ITit-IT-Cosimo
Italian - Italyit-ITit-IT-DiegoNeural
Italian - Italyit-ITit-IT-ElsaNeural
Italian - Italyit-ITit-IT-IsabellaNeural
Italian - Italyit-ITit-IT-LuciaRUS
Japanese - Japanja-JPja-JP-KeitaNeural
Japanese - Japanja-JPja-JP-NanamiNeural
Japanese - Japanja-JPja-JP-Ayumi-Apollo
Japanese - Japanja-JPja-JP-HarukaRUS
Japanese - Japanja-JPja-JP-Ichiro-Apollo
Japanese - Japanja-JPja-JP-Mizuki
Japanese - Japanja-JPja-JP-Takumi
Japanese - Japanja-JPja-JP-Ayumi
Japanese - Japanja-JPja-JP-Ichiro
Korean - Koreako-KRko-KR-InJoonNeural
Korean - Koreako-KRko-KR-SunHiNeural
Korean - Koreako-KRko-KR-HeamiRUS
Korean - Koreako-KRko-KR-Seoyeon
Latvian - Latvialv-LVlv-LV-EveritaNeural
Latvian - Latvialv-LVlv-LV-NilsNeural
Malay - Malaysiams-MYms-MY-OsmanNeural
Malay - Malaysiams-MYms-MY-YasminNeural
Malay - Malaysiams-MYms-MY-Rizwan
Maltese - Maltamt-MTmt-MT-GraceNeural
Maltese - Maltamt-MTmt-MT-JosephNeural
Norwegian (Bokm) - Norwaynb-NOnb-NO-IselinNeural
Norwegian (Bokm) - Norwaynb-NOnb-NO-PernilleNeural
Norwegian (Bokm) - Norwaynb-NOnb-NO-FinnNeural
Norwegian (Bokm) - Norwaynb-NOnb-NO-HuldaRUS
Norwegian (Bokm) - Norwaynb-NOnb-NO-Liv
Polish - Polandpl-PLpl-PL-ZofiaNeural
Polish - Polandpl-PLpl-PL-AgnieszkaNeural
Polish - Polandpl-PLpl-PL-MarekNeural
Polish - Polandpl-PLpl-PL-Ewa
Polish - Polandpl-PLpl-PL-Jacek
Polish - Polandpl-PLpl-PL-Jan
Polish - Polandpl-PLpl-PL-Maja
Polish - Polandpl-PLpl-PL-PaulinaRUS
Portuguese - Brazilpt-BRpt-BR-AntonioNeural
Portuguese - Brazilpt-BRpt-BR-FranciscaNeural
Portuguese - Brazilpt-BRpt-BR-Daniel-Apollo
Portuguese - Brazilpt-BRpt-BR-HeloisaRUS
Portuguese - Brazilpt-BRpt-BR-Ricardo
Portuguese - Brazilpt-BRpt-BR-Vitoria
Portuguese - Portugalpt-PTpt-PT-DuarteNeural
Portuguese - Portugalpt-PTpt-PT-FernandaNeural
Portuguese - Portugalpt-PTpt-PT-RaquelNeural
Portuguese - Portugalpt-PTpt-PT-Cristiano
Portuguese - Portugalpt-PTpt-PT-HeliaRUS
Portuguese - Portugalpt-PTpt-PT-Ines
Romanian - Romaniaro-ROro-RO-AlinaNeural
Romanian - Romaniaro-ROro-RO-EmilNeural
Romanian - Romaniaro-ROro-RO-Andrei
Romanian - Romaniaro-ROro-RO-Carmen
Russian - Russiaru-RUru-RU-DariyaNeural
Russian - Russiaru-RUru-RU-DmitryNeural
Russian - Russiaru-RUru-RU-Irina
Russian - Russiaru-RUru-RU-Pavel
Russian - Russiaru-RUru-RU-SvetlanaNeural
Russian - Russiaru-RUru-RU-EkaterinaRUS
Russian - Russiaru-RUru-RU-Irina-Apollo
Russian - Russiaru-RUru-RU-Maxim
Russian - Russiaru-RUru-RU-Pavel-Apollo
Russian - Russiaru-RUru-RU-Tatyana
Slovak - Slovakiask-SKsk-SK-LukasNeural
slovak - Slovakiask-SKsk-SK-ViktoriaNeural
Slovak - Slovakiasl-SIsl-SI-PetraNeural
Slovak - Slovakiasl-SIsl-SI-RokNeural
Slovak - Slovakiask-SKsk-SK-Filip
Slovenian - Sloveniasl-SIsl-SI-Lado
Spanish - Mexicoes-MXes-MX-DaliaNeural
Spanish - Mexicoes-MXes-MX-JorgeNeural
Spanish - Mexicoes-MXes-MX-Raul
Spanish - Mexicoes-MXes-MX-HildaRUS
Spanish - Mexicoes-MXes-MX-Raul-Apollo
Spanish - Spaines-ESes-ES-AlvaroNeural
Spanish - Spaines-ESes-ES-ElviraNeural
spanish - Spaines-ESes-ES-Laura
Spanish - Spaines-ESes-ES-Pablo
Spanish - Spaines-ESes-ES-Conchita
Spanish - Spaines-ESes-ES-Enrique
Spanish - Spaines-ESes-ES-HelenaRUS
Spanish - Spaines-ESes-ES-Laura-Apollo
Spanish - Spaines-ESes-ES-Pablo-Apollo
Spanish - United Stateses-USes-US-Miguel
Spanish - United Stateses-USes-US-Penelope
Swedish - Swedensv-SEsv-SE-HilleviNeural
Swedish - Swedensv-SEsv-SE-MattiasNeural
Swedish - Swedensv-SEsv-SE-SofieNeural
Swedish - Swedensv-SEsv-SE-Astrid
Swedish - Swedensv-SEsv-SE-HedvigRUS
Taiwanese - Taiwanzh-TWzh-TW-HanHanRUS
Taiwanese - Taiwanzh-TWzh-TW-Yating-Apollo
Taiwanese - Taiwanzh-TWzh-TW-Zhiwei-Apollo
Tamil - Indiata-INta-IN-PallaviNeural
Tamil - Indiata-INta-IN-ValluvarNeural
Tamil - Indiata-INta-IN-Valluvar
Telugu - Indiate-INte-IN-MohanNeural
Telugu - Indiate-INte-IN-ShrutiNeural
Telugu - Indiate-INte-IN-Chitra
Thai - Thailandth-THth-TH-AcharaNeural
Thai - Thailandth-THth-TH-NiwatNeural
Thai - Thailandth-THth-TH-PremwadeeNeural
Thai - Thailandth-THth-TH-Pattara
Turkish - Turkeytr-TRtr-TR-AhmetNeural
Turkish - Turkeytr-TRtr-TR-EmelNeural
Turkish - Turkeytr-TRtr-TR-Filiz
Turkish - Turkeytr-TRtr-TR-SedaRUS
Vietnamese - Vietnamvi-VNvi-VN-HoaiMyNeural
Vietnamese - Vietnamvi-VNvi-VN-NamMinhNeural
Vietnamese - Vietnamvi-VNvi-VN-An
Welsh - United Kingdomcy-GBcy-GB-Gwyneth