Input annotations present the user with an edit box in which to provide input. The following types of input annotations are available:

  • Text
  • Free text
  • Number
  • Password
  • Date
  • Currency

Text Input

A {TextInput} annotation presents an Edit Box in which the user can provide text input. The following example shows how to map a request for a customer's name.
In a Speech to Text Voice IVR, the Voice prompt is:

Please enter your account number

After mapping, the annotations are:

{Title}Please enter your account number {TextInput}

The figure below shows how the {TextInput} annotation is displayed in a VIVR VXML Connector page:

Free Text Input

The purpose of a {FreeTextInput} annotation is similar to that of a {TextInput} annotation, as they are both used for text input. The difference is that no validation is performed on a {FreeTextInput} annotation. The {FreeTextInput} annotation is generally used for alphanumeric input.

When a {FreeTextInput} annotation is used, VIVR VXML Connector populates the IVR parameters as follows:

Parameter Value
utterance The length (number of characters) of the free text input.
interpretation The free text input.

For example:

{Title}Please choose a user name {FreeTextInput} {TextInput}

The figure below shows how the {FreeTextInput} annotation is displayed in a VIVR VXML Connector page:

Number Input

A {NumberInput} annotation presents an Edit Box in which the user can provide numeric input. The following example shows how to map a request for a customer's account number. The Voice prompt is:

Please enter your account number

After mapping, the annotations are:

{Title}Please enter your account number {NumberInput}

The figure below shows how the {NumberInput} annotation is displayed in a VIVR VXML Connector page:

Password Input

A {PasswordInput} annotation presents an Edit Box in which the user's input is masked. The following example shows how to map a request for a customer's PIN number. The Voice prompt is:

Please enter your pin number

After mapping, the annotations are:

{Title}Please enter your pin number {PasswordInput}

The following figure shows how the {PasswordInput} annotation is presented in a VIVR VXML Connector page:

Date Input

A {DateInput} annotation presents an Edit Box in which the user can enter a specific date. The following example shows how to map a request for a customer's birthday. Before mapping, the Voice prompt is:

What is your date of birth?
Please type 2 digits for the month,
then pound, then 2 digits for the day,
then pound, and then 4 digits for the year.

After mapping, the annotations are:

{Title}Please enter your date of birth {DateInput}

If you wish to override the default date format set in the ProjectConfiguration.xml file, enter the desired format after the {DateInput} annotation. The format of the date determines how the selection is returned to the IVR.

The following date formats are supported:

{Title}Please enter your date of birth{DateInput} MM#DD#YYYY
{Title}Please enter your date of birth{DateInput} ddMMyyyy

The following figure shows how a {DateInput} annotation is presented in a VIVR VXML Connector page:

Currency Input

A {CurrencyInput} annotation presents an Edit Box in which the user can enter an amount of currency. The following example shows how to map a request to specify an amount of money. The Voice prompt is:

Please enter the amount you want to transfer.
Use the star key to separate between dollars and cents.

After mapping, the annotations are:

{Title}Please enter the amount
you want to transfer {CurrencyInput}

If you wish to override the default currency format set in the ProjectConfiguration.xml file, enter the desired format after the {CurrencyInput} annotation. The format of the currency determines how the selection is returned to the IVR.

The following currency formats are supported:

{Title}Please enter the amount you want to transfer {CurrencyInput} DDD*dd
{Title}Please enter the amount you want to transfer {CurrencyInput} DDD#dd*

The following figure shows how the {CurrencyInput} annotation is presented in a VIVR VXML Connector page:

Revision:

Comments