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:

Name

Type

Description

action

String

say – Text to speech function

text

String

The text to speech message that will be played on the call

language

String

The language of the spoken text, see in the table below of supported languages

voiceProfile

String

The voice profile of the spoken text, see in the table below the supported voice profiles

repetition

Integer

Defines the number of times the text will be repeated during the call.

clientActionId

String

A 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:

Language

Value

Male voice (M)

Female voice (F)

English

EN

Yes

Yes

Chinese

ZH

No

Yes

Danish

DA

Yes

Yes

Dutch

NL

Yes

Yes

French

FR

Yes

Yes

German

DE

Yes

Yes

Hindi

HI

No

Yes

Icelandic

IS

Yes

Yes

Italian

IT

Yes

Yes

Japanese

JA

Yes

Yes

Korean

SV

No

Yes

Norwegian

NB

No

Yes

Polish

PL

Yes

Yes

Portuguese

PT

Yes

Yes

Romanian

RO

No

Yes

Russian

RU

Yes

Yes

Spanish

ES

Yes

Yes

Swedish

SV

No

Yes

Thai

TH

No

Yes

Turkish

TR

No

Yes

Vietnamese

VN

Yes

Yes

Welsh

CY

No

Yes