Show TOC

Background documentationURL Parameters of a Voice Application Locate this document in the navigation structure

 

You can add some additional optional parameters to the voice application URL. By doing this you can change 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.

IP address of the hostname.

vsProxyPort

Overrides the HTTP proxy port specified in the service.

port number of the proxy server used.

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.

-

Example Example

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.

End of the example.