VoiceObjects Application URL
Parameters
You can start every deployed voice application with a unique URL, which becomes available when you deploy the voice application. You copy the URL and configure it into a VoiceXML gateway to launch the application in response to an incoming telephone call.
You can append some additional optional parameters to this URL to modify the behavior of the application when it is launched. For example, you can disable Barge-in behavior or instruct the server to render your application using a different VoiceXML Gateway driver.
The following table contains the possible optional parameters:
Parameter |
Description |
Value(s) |
vsBargein |
Overrides the default barge-in setting specified in the service |
true false |
vsContentType |
Overrides the content type specified in the service |
- |
vsDialogTimeout |
Overrides the dialog timeout specified in the service |
Interpreted in seconds |
vsDriver |
Overrides the media platform driver specified in the service |
- |
vsExitType |
Overrides the dialog exit type specified in the service |
disconnect exit return |
vsGrammarMediaType |
Overrides the default grammar type specified in the service |
abnf gsl jsgf srgs_xml regex precompiled none |
vsGrammarMode |
Overrides the default grammar mode specified in the service |
embedded:external external:embedded |
vsInputMode |
Overrides the default input mode specified in the service |
voice dtmf voicedtmf |
vsLanguage |
Overrides the application language specified in the service |
- |
vsOutputMode |
Overrides the default output mode specified in the service |
audio:tts tts:audio |
vsProxyHost |
Overrides the HTTP proxy host specified in the service |
- |
vsProxyPort |
Overrides the HTTP proxy port specified in the service |
- |
vsRejectResponse |
Overrides the reject response specified in the service |
overflow redirect |
vsRecordingScope |
Overrides the default recording scope specified in the service |
all noMatch recognition |
vsRecordUtterances |
Overrides the default value of the Record utterances setting specified in the service |
true false |
vsSessionVariables |
Overrides the default value of the Session variables setting in the service. |
- |
vsStandbyTimeout |
Overrides the standby timeout specified in the service |
Interpreted in seconds |
varVarID |
Overrides the value of the specified variable
VarID must match the reference ID of the variable that needs to be overwritten with the specified value. |
- |
layLayerID |
Overrides the initial state of the specified layer
LayerID must match the reference ID of the layer, the default state of the reference ID needs to be overwritten with the specified state ID. |
- |
An example for using these parameters:
The content type of the markup returned to the voice platform depends on the selected driver and is set to application/voicexml+xml in most voice and video drivers. To change this value, specify vsContentType as the parameter and the required setting as the value in the connection URL. You set the parameter as vsContentType=text/xml to allow the rendered VoiceXML pages to be viewed in a web browser for debugging.