Input Mode

string

Yes

true

false

voice

The type of entry allowed for input. Possible values are voice (voice only) and dtmf+voice (DTMF and voice).

NoInput Timeout

int ≥ 0

Yes

true

true

5s

The maximum duration allowed for silence before a NoInput event is triggered. Possible values are standard time designations including non-negative numbers and a time unit. For example, 3s (for seconds) or 300 ms (for milliseconds).

Max NoInput Count

int ≥ 0

Yes

true

true

3

The maximum number of noinput events allowed during input capture. Possible values are int > 0 where 0 indicates infinite NoInput events permitted.

Max NoMatch Count

int ≥ 0

Yes

true

true

3

The maximum number of NoMatch events allowed during DTMF input capture. Possible values are int > 0 where 0 indicates infinite NoMatch events permitted.

DTMF Grammar

string

Yes

true

yes

None

This option is mandatory only if the input mode selected is DTMF and voice. It supports Cisco DTMF regex.

Secure Logging

boolean

Yes

true

true

false

Indicates whether logging of potentially sensitive data of the element is enabled. If this is set to true, the element's potentially sensitive data is not logged.

Termination Character

String

No

true

true

#

Terminates the voice stream or DTMF collection.

Max Input Time

int ≥ 0

Yes

true

true

30s

The maximum time (in seconds) the voice input is allowed to last. Possible values are positive integer values followed by s (seconds). For example, 50s. Default value is 30s.

Final Silence

int ≥ 0

Yes

true

true

2s

The interval of silence (in seconds or milliseconds) that indicates the end of speech. Possible values are positive integer values followed by either s (seconds) or ms (milliseconds). For example, 3s and 3000ms. Default value is 2s.

intent

string

Yes

true

false

None

The current intent to be processed for parameter extraction.

variable

string

Yes

true

false

None

The variable to be processed for a particular intent mentioned in intent field.

Last Parameter

boolean

Yes

true

true

false

This indicates end of parameter capture. If it is set to true, the intent is marked as complete.

Recognize.phraseHints

String

No

true

true

None

This is comma separated string that lists the hints for recognition.

Hints are used to recognize a phrase or a word that is pronounced differently.

For example, Savings, Current.

Dialogflow.queryParams

.payload

JSON

Sets the payload to be sent to Dialogflow.

Dialogflow.queryParams

.timeZone

String

Sets the timezone to be sent to Dialogflow.

For example, America/New_York, Europe/Paris.

Dialogflow.queryParams.geoLocation

String

(comma separated value)

Sets the geographical location to be sent to Dialogflow.

For example, "50.0,50.0".

Dialogflow.queryParams.

sessionEntityTypes

JSON

Sets the additional entity types to be sent to Dialogflow.

For example, [{'name': 'class','entityOverrideMode': 'ENTITY_OVERRIDE_MODE_OVERRIDE','entities': [{'value': 'economy','synonyms': ['eco', 'economy']}]}].

Dialogflow.queryParams

.sentimentAnalysisRequestConfig

Boolean

Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed.

action

This is the action parameter from Dialogflow.

fulillment_text

This is fulfillment text from Dialogflow.

input_type

Indicates the type of input captured (dtmf or dtmf+voice).

intent

Indicates the intent of a parameter.

json

JSON response from Dialogflow.

original_value

Indicates the parameter value as uttered by the user in string.

value

This is the parameter value returned by Dialogflow if input type is voice.

If input type is dtmf, it contains the DTMF key that is pressed by the user.

confidence

The Speech recognition confidence between 0.0 and 1.0. A higher number indicates a greater probability that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set.

sentiment_score

Sentiment score of the user input.

Done

This is returned when the configured parameter is filled.

Intent_Change

This is returned when Dialogflow switches to a different intent whose filling slot is based on user utterance.

MAX_NoInput

This state is encountered when there is no input from the user for a specified duration as configured in the setting.

MAX_NoMatch

This state is returned when the variable or parameter mentioned in element setting is not matched for specified number of times as mentioned in settings.

If the input type is dtmf+voice, this state is encountered when the DTMF input does not match regex grammar for the specified number of times as mentioned in settings.

Form

com.audium.server.voiceElement.form

Event Type

You can select Java Exception, VXML Event, or Hotlink as the event handler for this element.