Declared in Voiceflow.schema.json

Overview

Voiceflow modules make up Voiceflows which are interpreted and processed to execute speech-enabled conversational interactions between Programs and Users. Voiceflow modules are of the following types:

    - node
    - process
    - pauseResume
    - playAudio
    - recordAudio
    - audioDialog
    - audioListener
    - runAEC

Note: Unless stated otherwise, value of properties that are of type "string" can be updated at runtime by an application if their value is entered as a field name wrapped by "$[" and "]". If a property is of a type other than "string", then an additional property of type "string" with the same property name appended with the string "Runtime" is added to have its value entered as a field name wrapped by "$[" and "]". This allows the application to set the value of the field name at runtime to be the value of the original non-runtime property. Valid values of runtime fields override the values of non-runtime properties.

Tasks

  •   id

    Unique ID of a Voiceflow Module. User defined. Use reserved IDs "VF_START" and "VF_END" with type "node" to define start and end Voiceflow Modules required in a Voiceflow. The value cannot be set at runtime.`

    Parameter is required.

           property
  •   type

    Type of a Voiceflow Module. Values: "node", "process", "pauseResume", "playAudio", "recordAudio", "audioDialog", "audioListener", or "runAEC". The value cannot be set at runtime.`

    Parameter is required.

           property
  •   name

    The name of a Voiceflow Module. User defined. The value cannot be set at runtime.`

    Parameter is required.

           property
  •   processParams

    Specifies the parameters for a "process" type Voiceflow Module. "processParams" configuration is used in "process" type Voiceflow Module.`

    Parameter is optional.

           property
  •   audioInterruptTransitionParams

    Specifies the parameters for transitioning Voiceflow processing to a Voiceflow Module after Audio Session interruption ends. "audioInterruptTransitionParams" configuration is used in all Voiceflow Modules but more relevant when used in Voiceflow Modules that perform audio playback: "playAudio", "recordAudio", "audioDialog" and "audioListener". "audioInterruptTransitionParams" configured in "process" type Voiceflow Module will set the default audio interruption transition for the Voiceflow. "audioInterruptTransitionParams" configured in other type Voiceflow Modules will set the audio interruption transition for those specifc Voiceflow Modules and will override the default one set for the Voiceflow.

    Parameter is optional.

           property
  •   playAudioParams

    Specifies the parameters for a "playAudio" type Voiceflow Module. "playAudioParams" configuration is used in "playAudio" type Voiceflow Module.

    Parameter is optional.

           property
  •   recordAudioParams

    Specifies the parameters for recording audio. "recordAudioParams" configuration is used in Voiceflow Modules of types "recordAudio", "audioDialog" and "audioListener".

    Parameter is optional.

           property
  •   recognizeAudioParams

    Specifies the parameters for speech recognition of audio. "recognizeAudioParams" configuration is used in Voiceflow Modules of types "audioDialog" and "audioListener".

    Parameter is optional.

           property
  •   audioDialogParams

    Specifies the parameters for an "audioDialog" type Voiceflow Module. "audioDialogParams" configuration is used in an "audioDialog" type Voiceflow Module.

    Parameter is optional.

           property
  •   audioListenerParams

    Specifies the parameters for a "audioListener" type Voiceflow Module. "audioListenerParams" configuration is used in "audioListener" type Voiceflow Module.

    Parameter is optional.

           property
  •   runAECParams

    Specifies the parameters for a "runAEC" type Voiceflow Module. "runAECParams" configuration is used in "runAECParams" type Voiceflow Module.

    Parameter is optional.

           property
  •   goTo

    Specifies the next Voiceflow Module ID to transition to for processing. Voiceflow Module IDs to transition to can be static or can be assigned dynamically to a Key and retrieved at runtime if noted as $[Key].

    Parameter is required.

           property

Properties

audioDialogParams

"audioDialogParams": object - AudioDialogParams

Discussion

Specifies the parameters for an "audioDialog" type Voiceflow Module. "audioDialogParams" configuration is used in an "audioDialog" type Voiceflow Module.

Parameter is optional.

Declared In

Voiceflow.schema.json

audioInterruptTransitionParams

"audioInterruptTransitionParams": object - AudioInterruptTransitionParams

Discussion

Specifies the parameters for transitioning Voiceflow processing to a Voiceflow Module after Audio Session interruption ends. "audioInterruptTransitionParams" configuration is used in all Voiceflow Modules but more relevant when used in Voiceflow Modules that perform audio playback: "playAudio", "recordAudio", "audioDialog" and "audioListener". "audioInterruptTransitionParams" configured in "process" type Voiceflow Module will set the default audio interruption transition for the Voiceflow. "audioInterruptTransitionParams" configured in other type Voiceflow Modules will set the audio interruption transition for those specifc Voiceflow Modules and will override the default one set for the Voiceflow.

Parameter is optional.

Declared In

Voiceflow.schema.json

audioListenerParams

"audioListenerParams": object - AudioListenerParams

Discussion

Specifies the parameters for a "audioListener" type Voiceflow Module. "audioListenerParams" configuration is used in "audioListener" type Voiceflow Module.

Parameter is optional.

Declared In

Voiceflow.schema.json

goTo

"goTo": object - GoTo

Discussion

Specifies the next Voiceflow Module ID to transition to for processing. Voiceflow Module IDs to transition to can be static or can be assigned dynamically to a Key and retrieved at runtime if noted as $[Key].

Parameter is required.

Declared In

Voiceflow.schema.json

id

"id": string

Discussion

Unique ID of a Voiceflow Module. User defined. Use reserved IDs "VF_START" and "VF_END" with type "node" to define start and end Voiceflow Modules required in a Voiceflow. The value cannot be set at runtime.`

Parameter is required.

Declared In

Voiceflow.schema.json

name

"name": string

Discussion

The name of a Voiceflow Module. User defined. The value cannot be set at runtime.`

Parameter is required.

Declared In

Voiceflow.schema.json

playAudioParams

"playAudioParams": object - PlayAudioParams

Discussion

Specifies the parameters for a "playAudio" type Voiceflow Module. "playAudioParams" configuration is used in "playAudio" type Voiceflow Module.

Parameter is optional.

Declared In

Voiceflow.schema.json

processParams

"processParams": object - ProcessParams

Discussion

Specifies the parameters for a "process" type Voiceflow Module. "processParams" configuration is used in "process" type Voiceflow Module.`

Parameter is optional.

Declared In

Voiceflow.schema.json

recognizeAudioParams

"recognizeAudioParams": object - RecognizeAudioParams

Discussion

Specifies the parameters for speech recognition of audio. "recognizeAudioParams" configuration is used in Voiceflow Modules of types "audioDialog" and "audioListener".

Parameter is optional.

Declared In

Voiceflow.schema.json

recordAudioParams

"recordAudioParams": object - RecordAudioParams

Discussion

Specifies the parameters for recording audio. "recordAudioParams" configuration is used in Voiceflow Modules of types "recordAudio", "audioDialog" and "audioListener".

Parameter is optional.

Declared In

Voiceflow.schema.json

runAECParams

"runAECParams": object - RunAECParams

Discussion

Specifies the parameters for a "runAEC" type Voiceflow Module. "runAECParams" configuration is used in "runAECParams" type Voiceflow Module.

Parameter is optional.

Declared In

Voiceflow.schema.json

type

"type": string

Discussion

Type of a Voiceflow Module. Values: "node", "process", "pauseResume", "playAudio", "recordAudio", "audioDialog", "audioListener", or "runAEC". The value cannot be set at runtime.`

Parameter is required.

Declared In

Voiceflow.schema.json