VoiceXML Async Cancel

This VoiceXML tool sends a request to the VoiceXML Interpreter to cancel play/input operations.

The request is asynchronous. That means the tool returns as soon as the VoiceXML cancel request has been initiated. 

The VoiceXML interpreter “owns” the interaction when the tool returns through the ‘Success’ exit. The handler may not perform operations against the interaction unless it re-acquires the ownership (in which case the VoiceXML session will abort immediately).  

If the tool exits through the ‘Invalid Interaction’ or ‘Error’ exit, the handler remains the owner of the interaction.

Inputs

Interaction

The unique interaction identifier (e.g., CallID) to send to the VoiceXML interpreter.

Outputs

Event Name

This string is the VoiceXML event that caused the interpreter to exit, or the reason for a session initiation failure.  

It is an empty string if the session terminated through the <exit> element.

Event Message

This string is additional message text associated with the VoiceXML event (‘_message’ property).

Exit Paths

Success

The VoiceXML cancel request completed successfully.