TTS

Speak in calls with text-to-speech

About TTS

Speak in calls automatically using tts engines. In order to use tts, the account must have an engine configured. 2600Hz has Flite configured out of the box. See this tutorial for adding a different tts engine.

Schema

Validator for the TTS (Text-to-speech) callflow action

KeyDescriptionTypeDefaultRequiredSupport Level
endless_playbackLoop the media until canceledboolean()false
engineWhat TTS engine to usestring('flite' | 'google' | 'ispeech' | 'voicefabric')false
languageThe language of the speakerstring()false
skip_moduleWhen set to true this callflow action is skipped, advancing to the wildcard branch (if any)boolean()false
terminators.[]string()false
terminatorsWhat DTMF can terminate playback of the audioarray(string())["1", "2", "3", "4", "5", "6", "7", "8", "9", "*", "0", "#"]false
textThe text to speakstring(1..1000)true
voiceWhat voice to use when speaking the textstring()femalefalse

Examples

This example will use the default TTS engine to speak the text and then hang up.

{
    "module": "tts",
    "data": {
        "text": "2600Hz is pretty awesome. Have a great day."
    }
}

On this page