VoiceXML session properties

Last Updated : Dec 07, 2012 |
At the start of a VoiceXML session, the Application Interface web service places several properties in the session.connection, session.avaya.telephone, and session.telephone namespaces.
Prolog information
Metadata
Keywords:

session.connection namespace properties

Property
Description
call_tag
The unique identifier for the session assigned by the Media Server.
ccxml.namelist.*
If the CCXML application passes data to the VoiceXML dialog at the beginning of the session, this array variable contains a list of the variable names passed by the CCXML application.
ccxml.values.*
If the CCXML application passes data to the VoiceXML dialog at the beginning of the session, this array variable contains a list of the values for the variable names contained in ccxml.namelist.*.
local.uri
The Dialed Number Identification Service (DNIS) associated with the call that triggered the VoiceXML session.
protocol.name
The telephony protocol name. The options are:
  • h323
  • sip
remote.uri
The Automatic Number Identification (ANI) associated with the call that triggered the VoiceXML session.

session.avaya namespace properties

Note:
For convenience, several of the session.avaya namespace properties are the same as the session.connection namespace properties.
Property
Description
telephone.ani
The Automatic Number Identification (ANI) associated with the call that triggered the VoiceXML session.
telephone.call_tag
The unique identifier for the session assigned by the Media Server.
telephone.called_extension
For calls using an H.323 connection, this is the telephony port servicing the VoiceXML session.
telephone.callid
The unique identifier for the call assigned by the Media Server.
telephone.channel
This property is reserved for future use.
telephone.dnis
The Dialed Number Identification Service (DNIS) associated with the call that triggered the VoiceXML session.
telephone.startPage
The full URL, including any query string parameters, used to fetch the first page of the VoiceXML session.
uui.mode
The User-to-User Interface (UUI) mode under which this application is operating. The options are:
  • shared
  • service provider
uui.shared[]
If uui.mode is shared, this property contains an array of the shared UUI data pieces in name-value format.

session.telephone namespace properties

Note:
For convenience, most of the session.telephone namespace properties are the same as the session.connection and session.avaya namespace properties.
Property
Description
ani
The Automatic Number Identification (ANI) associated with the call that triggered the VoiceXML session.
dnis
The Dialed Number Identification Service (DNIS) associated with the call that triggered the VoiceXML session.
call_tag
The unique identifier for the session assigned by the Media Server.
called_extension
For calls using an H.323 connection, this is the telephony port servicing the VoiceXML session.
callid
The unique identifier for the call assigned by the Media Server.
channel
This property is reserved for future use.
startPage
The full URL, including any query string parameters, used to fetch the first page of the VoiceXML session.
*
This property contains any parameters passed to the Application Interface web service through the LaunchVXML method.