v1

latestOpenAPI 3.0.02026-07-1494623.7 KB

Play TTS

Play text to speech into a call

Play text to speech into a call

put/{uuid}/talk

Request body

language'ar' | 'ca-ES' | 'cmn-CN' | 'cmn-TW' | 'cs-CZ' | 'cy-GB' | 'da-DK' | 'de-DE' | 'el-GR' | 'en-AU' | 'en-GB' | 'en-GB-WLS' | 'en-IN' | 'en-US' | 'en-ZA' | 'es-ES' | 'es-MX' | 'es-US' | 'eu-ES' | 'fi-FI' | 'fil-PH' | 'fr-CA' | 'fr-FR' | 'he-IL' | 'hi-IN' | 'hu-HU' | 'id-ID' | 'is-IS' | 'it-IT' | 'ja-JP' | 'ko-KR' | 'nb-NO' | 'nl-NL' | 'no-NO' | 'pl-PL' | 'pt-BR' | 'pt-PT' | 'ro-RO' | 'ru-RU' | 'sk-SK' | 'sv-SE' | 'th-TH' | 'tr-TR' | 'uk-UA' | 'vi-VN' | 'yue-CN'

The language to use

levelstring

The volume level that the speech is played. This can be any value between -1 to 1 in 0.1 increments, with 0 being the default.

loopinteger

The number of times to repeat the text the file, 0 for infinite

premiumboolean

Set to true to use the premium version of the specified style if available, otherwise the standard version will be used. The default value is false. You can find more information about Premium Voices in the Text-To-Speech guide.

styleinteger

The vocal style (vocal range, tessitura, and timbre) to use

textstring required

The text to read

voice_name'Aditi' | 'Agnieszka' | 'Alva' | 'Amy' | 'Astrid' | 'Bianca' | 'Brian' | 'Carla' | 'Carmen' | 'Carmit' | 'Catarina' | 'Celine' | 'Cem' | 'Chantal' | 'Chipmunk' | 'Conchita' | 'Cristiano' | 'Damayanti' | 'Dora' | 'Emma' | 'Empar' | 'Enrique' | 'Eric' | 'Ewa' | 'Felipe' | 'Filiz' | 'Geraint' | 'Giorgio' | 'Gwyneth' | 'Hans' | 'Henrik' | 'Ines' | 'Ioana' | 'Iveta' | 'Ivy' | 'Jacek' | 'Jan' | 'Jennifer' | 'Joana' | 'Joanna' | 'Joey' | 'Jordi' | 'Justin' | 'Kanya' | 'Karl' | 'Kendra' | 'Kimberly' | 'Laila' | 'Laura' | 'Lea' | 'Lekha' | 'Liv' | 'Lotte' | 'Lucia' | 'Luciana' | 'Mads' | 'Maged' | 'Maja' | 'Mariska' | 'Marlene' | 'Mathieu' | 'Matthew' | 'Maxim' | 'Mei-Jia' | 'Melina' | 'Mia' | 'Miguel' | 'Miren' | 'Mizuki' | 'Montserrat' | 'Naja' | 'Nicole' | 'Nikos' | 'Nora' | 'Oskar' | 'Penelope' | 'Raveena' | 'Ricardo' | 'Ruben' | 'Russell' | 'Salli' | 'Satu' | 'Seoyeon' | 'Sin-Ji' | 'Sora' | 'Takumi' | 'Tarik' | 'Tatyana' | 'Tessa' | 'Tian-Tian' | 'Vicki' | 'Vitoria' | 'Yelda' | 'Zeina' | 'Zhiyu' | 'Zuzana'

<strong>DEPRECATED</strong> The voice & language to use

Example request

{
  "level": "0.4",
  "text": "Hello. How are you today?"
}

Response

Ok

messagestring

Description of the action taken

uuidstring uuid

The unique identifier for this call leg. The UUID is created when your call request is accepted by Vonage. You use the UUID in all requests for individual live calls

Example response

{
  "message": "Talk started",
  "uuid": "63f61863-4a51-4f6b-86e1-46edebcf9356"
}