Information events

This section describes the information events supported by Voice Platform.

cancel

This event is thrown when users say "Cancel." By default, the Voice Browser service will not provide audio or reprompt the user.

exit

This event is thrown when users say "Exit." By default, the Voice Browser service will behave the same way it would if an <exit> element was encountered.

help

This event is thrown when users say "Help." By default, the Voice Browser service will inform the user that an operator is not available. It will then reprompt the user.

noinput

This event is thrown when users do not responded within the timeout interval. By default, the user is reprompted.

nomatch

This event is thrown when users provide input (DTMF or speech) that does not match the active grammar. By default, the Voice Browser service will inform the user that the response was not understood. It will then reprompt the user.

maxspeechtimeout

This event is thrown when the user's input is too long, exceeding the maxspeechtimeout property. By default, the Voice Browser service will inform the user that the response was not understood. It will then reprompt the user.

connection.disconnect.hangup

This event is thrown if a user hangs up during a running application. By default, the Voice Browser service will behave the same way it would if an <exit> element was encountered.

connection.disconnect.transfer

This event is thrown when a caller is disconnected as a result of a transfer. The caller will always be disconnected from the system during blind transfers, and may also be disconnected during consultation or conditional transfers. During a consultation or conditional transfer, if the caller is successfully connected to the callee, this event will be thrown by the <transfer> element.

Consultation transfers are VoiceXML 2.1-compliant. Conditional transfers, a Nuance extension for VoiceXML 2.0, are supported for compatibility with previous releases of Voice Platform.

nuance.sessionended (Nuance extension)

This event is similar to the connection.disconnect.hangup event but differs in these ways:

  • This event is thrown when the user hangs up or the application exits (implicitly or explicitly).
  • This event is thrown in all applications encountered over the life of the call (not just in the current running application).
  • Only the application root can catch this event.

Note: This event is a Nuance extension. It allows applications to do post-call cleanup processing in a unified manner.

nuance.interrupt.aai (Nuance extension)

This event is thrown when incoming application-to-application information (aai) is detected during a call. To extract the aai, the receiving application must catch this event and assign its contents to a variable.

nuance.interrupt.device.{tone_event}.nss (Nuance extension)

This event is thrown when an answering-machine, dtmf, fax, sit (special information tone), or tty (teletypewriter) tone is detected during an outbound or inbound call. The tone_event indicates the tone detected For example, when Voice Browser service detects a fax machine, it throws this event (and strips off the nss):

nuance.interrupt.device.fax

You must also have enabled Tone detection on the Nuance Speech Server.