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",
        "voiceProfile": "generic-en-male",
        "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 and language are:

LanguageValueMale voice (M)Female voice (F)
EnglishENYesYes
ChineseZHNoYes
DanishDAYesYes
DutchNLYesYes
FrenchFRYesYes
GermanDEYesYes
HindiHINoYes
IcelandicISYesYes
ItalianITYesYes
JapaneseJAYesYes
KoreanSVNoYes
NorwegianNBNoYes
PolishPLYesYes
PortuguesePTYesYes
RomanianRONoYes
RussianRUYesYes
SpanishESYesYes
SwedishSVNoYes
ThaiTHNoYes
TurkishTRNoYes
VietnameseVNYesYes
WelshCYNoYes