Say&Capture

This action should be used to play a text to speech message and capture user inputs.

The following is an example of the JSON response you would need to provide:

{
  "clientActionId": "VoiceIvrId1",
    "callflow": [ 
    {
      "action": "say&capture",
        "params": {
          "text": "Hello This is a test message", 
          "language": "en",
          "voiceProfile": "generic-en-male",
          "repetition": 1,
          "minDigits": 5
       }
    }
  ] 
}

The action should contain the following parameters:

Name

Type

Description

action

String

say&capture – Action to play an TTS message and capture user inputs

text

String

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

language

String

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

voiceProfile

Boolean

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

repetition

Integer

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

minDigits

Integer

(Optional) Minimum number of dial-pad inputs that the calling user can make. Accepted values are from 1 to 20.

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.

Recommended audio type is WAV (PCM, alaw, 8000hz, mono) and the max file size is 1MB.