Declared in Voiceflow.schema.json

Overview

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

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

  •   unknownError

    Unknown error. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   writeToStreamError

    Write to stream error. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   alreadyRecording

    Audio recording did not start because audio recording is already active. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   recordingFileError

    Recording to file error. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   audioFormatError

    Audio Format error. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   unknown

    Unknown reason. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   stopRequest

    Received a stop audio recording request. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   maxAudioExceeded

    Audio recorded in file exceeded maximum duration threshold. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   maxRecordingExceeded

    Audio read from audio source to be processed and recorded exceeded maximum duration threshold. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   maxPreSpeechSilenceExceeded

    Pre-speech silence duration exceeded maximum pre-speech duration threshold. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   maxPostSpeechSilenceExceeded

    Post-speech silence duration exceeded maximum post-speech duration threshold. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   maxSpeechExceeded

    Speech duration exceeded maximum speech duration threshold. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   reachedEndOfFile

    Reached end of file. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter

JSON Parameters

alreadyRecording

"alreadyRecording": string

Discussion

Audio recording did not start because audio recording is already active. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

audioFormatError

"audioFormatError": string

Discussion

Audio Format error. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

maxAudioExceeded

"maxAudioExceeded": string

Discussion

Audio recorded in file exceeded maximum duration threshold. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

maxPostSpeechSilenceExceeded

"maxPostSpeechSilenceExceeded": string

Discussion

Post-speech silence duration exceeded maximum post-speech duration threshold. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

maxPreSpeechSilenceExceeded

"maxPreSpeechSilenceExceeded": string

Discussion

Pre-speech silence duration exceeded maximum pre-speech duration threshold. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

maxRecordingExceeded

"maxRecordingExceeded": string

Discussion

Audio read from audio source to be processed and recorded exceeded maximum duration threshold. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

maxSpeechExceeded

"maxSpeechExceeded": string

Discussion

Speech duration exceeded maximum speech duration threshold. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

reachedEndOfFile

"reachedEndOfFile": string

Discussion

Reached end of file. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

recordingFileError

"recordingFileError": string

Discussion

Recording to file error. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

stopRequest

"stopRequest": string

Discussion

Received a stop audio recording request. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

unknown

"unknown": string

Discussion

Unknown reason. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

unknownError

"unknownError": string

Discussion

Unknown error. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

writeToStreamError

"writeToStreamError": string

Discussion

Write to stream error. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json