text required
string
Text to read. Use the Speech Synthesis Markup Language (SSML) in a request to fine-tune your output.
language required
string
Enum: "ar" "bn" "bg" "ca" "zh-cn" "zh-tw" "hr" "cs" "da" "nl" "en" "en-au" "en-gb" "en-ca" "en-in" "en-ie" "en-gb-wls" "epo" "fil-ph" "fi" "fr" "fr-ca" "fr-ch" "de" "de-at" "de-ch" "el" "gu" "he" "hi" "hu" "is" "id" "it" "ja" "kn" "ko" "ms" "ml" "no" "pl" "pt-pt" "pt-br" "ro" "ru" "sk" "sl" "es" "es-gl" "es-mx" "sv" "ta" "te" "th" "tr" "uk" "vi" "wls" "ar-ma" "ur-pk" "mr-in"
Text language. Must be defined for correct pronunciation. For more details on available languages and voices, see our documentation .
speechRatenumber <double>
Speech rate. Must be within [0.5 - 2.0]
range, default value is 1
.
loopCountinteger <int32>
Number of times to read the text.
preferences voiceGenderstring
Enum: "FEMALE" "MALE"
Voice gender in which text would be synthesized.
voiceNamestring
Enum: "Zeina" "Aisha (beta)" "Farooq (beta)" "Hussein (beta)" "Amal (beta)" "Sayan (beta)" "Sushmita (beta)" "Darina" "Conchita" "Zhiyu" "Liu (beta)" "Wang (beta)" "Zhang (beta)" "Lin (beta)" "Akemi (beta)" "Chen (beta)" "Huang (beta)" "Fang" "Chao" "Ming" "Aneta" "Naja" "Mads" "Ruben" "Lotte" "Joanna" "Ivy" "Kendra" "Kimberly" "Salli" "Joey" "Justin" "Matthew" "Russell" "Nicole" "Brian" "Amy" "Emma" "Aditi" "Raveena" "Geraint" "Evelin (beta)" "Celine" "Lea" "Mathieu" "Chantal" "Vicki" "Hans" "Marlene" "Sophia (beta)" "Dinesh (beta)" "Leela (beta)" "Abigail" "Meira" "Idan" "Yosef" "Aadita" "Aarushi (beta)" "Akash (beta)" "Daman (beta)" "Divya (beta)" "Agota" "Dora" "Karl" "Indah (beta)" "Arif (beta)" "Reza (beta)" "Nurul (beta)" "Gianna (beta)" "Carla" "Bianca" "Giorgio" "Takumi" "Mizuki" "Shashank (beta)" "Namratha (beta)" "Seoyeon" "Sumi (beta)" "Jina (beta)" "Himchan (beta)" "Minho (beta)" "Ameera" "Nurin" "Nijat" "Fuaad" "Vishnu (beta)" "Kirti (beta)" "Liv" "Ewa" "Maja" "Jacek" "Jan" "Cristiano" "Ines" "Abrielle (beta)" "Henriques (beta)" "Jeraldo (beta)" "Jacinda (beta)" "Camila" "Ricardo" "Vitoria" "Carmen" "Maxim" "Tatyana" "Natalia" "Miguel" "Linda" "Enrique" "Gabriela (beta)" "Lupe" "Penelope" "Mia" "Astrid" "Ganesh (beta)" "Shruti (beta)" "Vijay (beta)" "Samantha (beta)" "Natchaya (beta)" "Filiz" "Ulyana" "Lien (beta)" "Quan (beta)" "Mai (beta)" "Tuan (beta)" "Gwyneth" "Aarya" "Arjun" "Revati" "Hamed (neural)" "Salma (neural)" "Shakir (neural)" "Zariyah (neural)" "Bashkar (neural)" "Tanishaa (neural)" "Borislav (neural)" "Kalina (neural)" "Alba (neural)" "Enric (neural)" "Joana (neural)" "Xiaochen (neural)" "Xiaohan (neural)" "Xiaomeng (neural)" "Xiaomo (neural)" "Xiaoqiu (neural)" "Xiaorou (neural)" "Xiaorui (neural)" "Xiaoxiao (neural)" "Xiaoyan (neural)" "Xiaoyi (neural)" "Xiaozhen (neural)" "Yunfeng (neural)" "Yunhao (neural)" "Yunjian (neural)" "Yunjie (neural)" "Yunxi (neural)" "Yunxia (neural)" "Yunyang (neural)" "Yunye (neural)" "Yunze (neural)" "HiuGaai (neural)" "HiuMaan (neural)" "HsiaoChen (neural)" "HsiaoYu (neural)" "WanLung (neural)" "YunJhe (neural)" "Gabrijela (neural)" "Srecko (neural)" "Antonin (neural)" "Vlasta (neural)" "Christel (neural)" "Jeppe (neural)" "Colette (neural)" "Fenna (neural)" "Maarten (neural)" "Amber (neural)" "Andrew (neural)" "Aria (neural)" "Ashley (neural)" "Ava (neural)" "Brandon (neural)" "Brian (neural)" "Christopher (neural)" "Cora (neural)" "Davis (neural)" "Elizabeth (neural)" "Emma (neural)" "Eric (neural)" "Guy (neural)" "Jacob (neural)" "Jane (neural)" "Jason (neural)" "Jenny (neural)" "Michelle (neural)" "Monica (neural)" "Nancy (neural)" "Roger (neural)" "Sara (neural)" "Steffan (neural)" "Tony (neural)" "Annette (neural)" "Carly (neural)" "Darren (neural)" "Duncan (neural)" "Elsie (neural)" "Freya (neural)" "Joanne (neural)" "Ken (neural)" "Kim (neural)" "Natasha (neural)" "Neil (neural)" "Tim (neural)" "Tina (neural)" "William (neural)" "Abbi (neural)" "Alfie (neural)" "Bella (neural)" "Elliot (neural)" "Ethan (neural)" "Hollie (neural)" "Libby (neural)" "Noah (neural)" "Oliver (neural)" "Olivia (neural)" "Ryan (neural)" "Sonia (neural)" "Thomas (neural)" "Clara (neural)" "Liam (neural)" "Neerja (neural)" "Prabhat (neural)" "Connor (neural)" "Emily (neural)" "Angelo (neural)" "Blessica (neural)" "Harri (neural)" "Noora (neural)" "Selma (neural)" "Alain (neural)" "Brigitte (neural)" "Celeste (neural)" "Claude (neural)" "Coralie (neural)" "Denise (neural)" "Henri (neural)" "Jacqueline (neural)" "Jerome (neural)" "Josephine (neural)" "Maurice (neural)" "Vivienne (neural)" "Yves (neural)" "Yvette (neural)" "Antoine (neural)" "Jean (neural)" "Sylvie (neural)" "Thierry (neural)" "Ariane (neural)" "Fabrice (neural)" "Amala (neural)" "Bernd (neural)" "Christoph (neural)" "Conrad (neural)" "Elke (neural)" "Kasper (neural)" "Katja (neural)" "Killian (neural)" "Klarissa (neural)" "Klaus (neural)" "Louisa (neural)" "Maja (neural)" "Ralf (neural)" "Seraphina (neural)" "Tanja (neural)" "Ingrid (neural)" "Jonas (neural)" "Jan (neural)" "Leni (neural)" "Athina (neural)" "Nestoras (neural)" "Dhwani (neural)" "Niranjan (neural)" "Avri (neural)" "Hila (neural)" "Madhur (neural)" "Swara (neural)" "Noemi (neural)" "Tamas (neural)" "Gudrun (neural)" "Gunnar (neural)" "Ardi (neural)" "Gadis (neural)" "Benigno (neural)" "Calimero (neural)" "Cataldo (neural)" "Diego (neural)" "Elsa (neural)" "Fabiola (neural)" "Fiamma (neural)" "Gianni (neural)" "Giuseppe (neural)" "Imelda (neural)" "Irma (neural)" "Isabella (neural)" "Lisandro (neural)" "Palmira (neural)" "Pierina (neural)" "Rinaldo (neural)" "Aoi (neural)" "Daichi (neural)" "Keita (neural)" "Mayu (neural)" "Nanami (neural)" "Naoki (neural)" "Shiori (neural)" "Gagan (neural)" "Sapna (neural)" "BongJin (neural)" "GookMin (neural)" "Hyunsu (neural)" "InJoon (neural)" "JiMin (neural)" "SeoHyeon (neural)" "SoonBok (neural)" "SunHi (neural)" "YuJin (neural)" "Osman (neural)" "Yasmin (neural)" "Midhun (neural)" "Sobhana (neural)" "Finn (neural)" "Iselin (neural)" "Pernille (neural)" "Agnieszka (neural)" "Marek (neural)" "Zofia (neural)" "Duarte (neural)" "Fernanda (neural)" "Raquel (neural)" "Antonio (neural)" "Brenda (neural)" "Donato (neural)" "Elza (neural)" "Fabio (neural)" "Francisca (neural)" "Giovanna (neural)" "Humberto (neural)" "Julio (neural)" "Leila (neural)" "Leticia (neural)" "Manuela (neural)" "Nicolau (neural)" "Thalita (neural)" "Valerio (neural)" "Yara (neural)" "Alina (neural)" "Emil (neural)" "Dariya (neural)" "Dmitry (neural)" "Svetlana (neural)" "Lukas (neural)" "Viktoria (neural)" "Petra (neural)" "Rok (neural)" "Abril (neural)" "Alonso (neural)" "Alvaro (neural)" "Arnau (neural)" "Dario (neural)" "Elias (neural)" "Elvira (neural)" "Estrella (neural)" "Irene (neural)" "Laia (neural)" "Lia (neural)" "Nil (neural)" "Paloma (neural)" "Saul (neural)" "Teo (neural)" "Triana (neural)" "Vera (neural)" "Ximena (neural)" "Beatriz (neural)" "Candela (neural)" "Carlota (neural)" "Cecilio (neural)" "Dalia (neural)" "Gerardo (neural)" "Jorge (neural)" "Larissa (neural)" "Liberto (neural)" "Luciano (neural)" "Marina (neural)" "Nuria (neural)" "Pelayo (neural)" "Renata (neural)" "Yago (neural)" "Hillevi (neural)" "Mattias (neural)" "Sofie (neural)" "Pallavi (neural)" "Valluvar (neural)" "Mohan (neural)" "Shruti (neural)" "Achara (neural)" "Niwat (neural)" "Premwadee (neural)" "Ahmet (neural)" "Emel (neural)" "Ostap (neural)" "Polina (neural)" "HoaiMy (neural)" "NamMinh (neural)" "Aled (neural)" "Nia (neural)" "Mouna (neural)" "Jamal (neural)" "Uzma (neural)" "Asad (neural)" "Aarohi (neural)" "Manohar (neural)"
Voice name in which text would be synthesized. More info about available languages and voices can be found here .
stopOnobject
Indicates when to stop the action. The action can be interrupted at any time by the end user when they press any DTMF key.
type terminatorstring
Digits used to end the audio playback. If no digits are set, any DTMF digit will end the audio playback. After first DTMF digit is pressed, playback will stop and pressed digit will be present in PLAY_FINISHED
or SAY_FINISHED
event.
If terminator is set to 123
, pressing either 1
, 2
or 3
will terminate the playback.
customDataobject
Optional parameter to update a call's custom data.
property name*string
Optional parameter to update a call's custom data.