Call classification allows the VoiceXML application to return the appropriate status code based on whether a human, an answering machine, or a fax machine answers an outbound call.
Call classification parameters for the LaunchVXML method
The following call classification name-value pairs can be passed as parameters with the LaunchVXML method. For both parameters the default is false, which means that you must specify the name-value pair in order to enable the associated functionality.
Name-value pair
Description
enable_call_classification=true
This required parameter enables call classification.
detect_greeting_end=true
This optional parameter instructs the VoiceXML application to identify the end of a recorded greeting if an answering machine answers the outbound call.
call_classification_recorded_msg_timeout = in mili secs (e.g. 30000 is 30 sec)
This Optional parameter is to set wait timeout for “end of recorded greeting”, if an answering machine answers the outbound call. Default is 30 sec.
call_classification_connectWhen = ( OnConnect or OnProgress)
This optional parameter is to start the CPA engine (call classification) on either OnConnect or OnProgress. By default it is set to OnProgress. In case the engine is started before connect, early media will also be captured for call classification.
call_classification_timeout=value
This optional parameter indicates how long the call classification function will run if it is unable to determine the classification. The value specified should be in milliseconds. If the value is not provided, the default timeout is 20 sec.
call_classification_timeout = in mili secs (e.g. 20000 is 20 sec)
Timeout for outbound call classification from engine. Default is 20 sec.
Call classifications
If you enable call classification, the VoiceXML application sends one of the following classifications to the application server using the query arguments on the URL:
Classification
Description
live_voice
If a human being answers the call, the application starts the previously-prepared VoiceXML dialog.
Note:
This is the default classification assigned to the VoiceXML session before the call is placed. If a human being does not answer the call, this classification must be changed.
recorded_msg
If the LaunchVXML method was invoked with detect_greeting_end=false or if the detect_greeting_end parameter was not specified and an answering machine answers the call, the application terminates the previously-prepared VoiceXML dialog and starts a new dialog by sending the classification recorded_msg to the application server.
msg_end
If the LaunchVXML method was invoked with detect_greeting_end=true and an answering machine answers the call, the application terminates the previously-prepared VoiceXML dialog and starts a new dialog by sending the classification msg_end to the application server.
fax_answer_tone
If a fax machine answers the call, the application terminates and returns the error code fax detected (8206) to the Application Interface web service.
timeout
If the VoiceXML application does not send a classification change message to the CCXML page within a given period of time, the CCXML applications assumes that a live person has answered the phone and it starts the previously-prepared VoiceXML dialog.
*
All other classifications result in the status code for no answer () being returned the Application Interface web service.
