Declared in Voiceflow.schema.json

Overview

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 value of field name and retrieved at runtime if noted as $[].

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.

Properties

  •   DEFAULT

    Specifies default Voiceflow Module ID to transition to if no other configured transition rules apply. Example: "DEFAULT": "VF_END" transitions processing to the Voiceflow Module VF_END which is a reserved Voiceflow Module ID for last Voiceflow Module to process in a Voiceflow. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is required.

           json parameter
  •   maxTimeoutCount

    Specifies the Voiceflow Module ID to transition to if a maximum timeout retry count is reached when processing "audioDialog" type Voiceflow Module. Default: value of "DEFAULT". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   maxGarbageCount

    Specifies the Voiceflow Module ID to transition to if a maximum garbage retry count is reached when processing "audioDialog" type Voiceflow Module. Default: value of "DEFAULT". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   maxSRErrorCount

    Specifies the Voiceflow Module ID to transition to if a maximum speech recognition error retry count is reached when processing "audioDialog" type Voiceflow Module. Default: value of "DEFAULT". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   maxTotalRetryCount

    Specifies the Voiceflow Module ID to transition to if a maximum total retry count is reached when processing "audioDialog" type Voiceflow Module. Default: value of "DEFAULT". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   loadPromptFailure

    Specifies the Voiceflow Module ID to transition to if an Audio Prompt Module failed to process for audio playback when processing "playAudio", "audioDialog", or "audioListener" type Voiceflow Modules. Default: value of "DEFAULT". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   internalFailure

    Specifies the Voiceflow Module ID to transition to if an internal failure is detected when processing a Voiceflow Module. Default: value of "DEFAULT". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   userInputCollection

    Specifies an array of Voiceflow Module IDs to transition to as a result of comparing a speech hypothesis to entries in list of valid user inputs.

    Parameter is optional.

           json parameter
  •   userIntentCollection

    Specifies an array of Voiceflow Module IDs to transition to as a result of Client classifying a speech hypothesis to a User intent that matches an entry in a list of valid user intents.

    Parameter is optional.

           json parameter
  •   stopRecordReason

    Specifies the Voiceflow Module IDs to transition to depending on the reason that caused audio recording to stop.

    Parameter is optional.

           json parameter

JSON Parameters

DEFAULT

"DEFAULT": string

Discussion

Specifies default Voiceflow Module ID to transition to if no other configured transition rules apply. Example: "DEFAULT": "VF_END" transitions processing to the Voiceflow Module VF_END which is a reserved Voiceflow Module ID for last Voiceflow Module to process in a Voiceflow. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is required.

Declared In

Voiceflow.schema.json

internalFailure

"internalFailure": string

Discussion

Specifies the Voiceflow Module ID to transition to if an internal failure is detected when processing a Voiceflow Module. Default: value of "DEFAULT". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

loadPromptFailure

"loadPromptFailure": string

Discussion

Specifies the Voiceflow Module ID to transition to if an Audio Prompt Module failed to process for audio playback when processing "playAudio", "audioDialog", or "audioListener" type Voiceflow Modules. Default: value of "DEFAULT". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

maxGarbageCount

"maxGarbageCount": string

Discussion

Specifies the Voiceflow Module ID to transition to if a maximum garbage retry count is reached when processing "audioDialog" type Voiceflow Module. Default: value of "DEFAULT". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

maxSRErrorCount

"maxSRErrorCount": string

Discussion

Specifies the Voiceflow Module ID to transition to if a maximum speech recognition error retry count is reached when processing "audioDialog" type Voiceflow Module. Default: value of "DEFAULT". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

maxTimeoutCount

"maxTimeoutCount": string

Discussion

Specifies the Voiceflow Module ID to transition to if a maximum timeout retry count is reached when processing "audioDialog" type Voiceflow Module. Default: value of "DEFAULT". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

maxTotalRetryCount

"maxTotalRetryCount": string

Discussion

Specifies the Voiceflow Module ID to transition to if a maximum total retry count is reached when processing "audioDialog" type Voiceflow Module. Default: value of "DEFAULT". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

stopRecordReason

"stopRecordReason": object - goToForStopRecordReason

Discussion

Specifies the Voiceflow Module IDs to transition to depending on the reason that caused audio recording to stop.

Parameter is optional.

Declared In

Voiceflow.schema.json

userInputCollection

"userInputCollection": array - [goToForUserInput]

Discussion

Specifies an array of Voiceflow Module IDs to transition to as a result of comparing a speech hypothesis to entries in list of valid user inputs.

Parameter is optional.

Declared In

Voiceflow.schema.json

userIntentCollection

"userIntentCollection": array - [goToForUserIntent]

Discussion

Specifies an array of Voiceflow Module IDs to transition to as a result of Client classifying a speech hypothesis to a User intent that matches an entry in a list of valid user intents.

Parameter is optional.

Declared In

Voiceflow.schema.json