Jump to: navigation, search

GVP MCP:vxmli:session vars



View in ref guide.

Edit this option          Publish this option          Clear draft content


Published Option

session_vars

Default Value: session.connection.local.uri|LOCALURI|1|session.connection.remote.uri|REMOTEURI|1|session.connection.originator|ORIGIN|1|session.connection.protocol.name|PROTOCOLNAME|0|session.connection.protocol.version|PROTOCOLVERSION|0|session.connection.protocol.sip.headers|Sip.Invite|6|session.connection.protocol.sip.headers.originalcase|Sip.Invite.originalcase|6|session.connection.redirect|REDIRECTHEADER|7|session.connection.callidref|CALLIDREF|1|session.vendor_name.instance.parent|PARENT|1|session.connection.ocn|OCN|1|session.connection.rdnis|RDNIS|1|session.connection.rreason|RREASON|1|session.connection.uuid|XGENESYSCALLUUID|1|session.connection.dn|IVRPORT|1|session.vendor_name.cs.username|XGENESYSCSUSERNAME|1|session.vendor_name.cs.password|XGENESYSCSPASSWORD|1|session.connection.record|Record.Status|0
Valid Values: <session-variable>|<variable-name>|(0|1|2|3)[|<session-variable>|<variable-name>|(0|1|2|3)]*
Changes Take Effect: At start/restart


Each session variable entry is composed of three components. The first component is the session variable name as exposed within VoiceXML. The second component is the variable name sent back from the Call Manager. The third component indicates either whether the session variable will be included in the request for the initial page URL (0 = do not include, 1 = include in GET, 2 = include in POST, 3 = include in GET and POST), or the type of array of the session variable (6 = associative array, 7 = array specific for draft-burke). This is a '|' delimited list. Besides the default variables, session.connection.protocol.sip.body (session.connection.protocol.sip.body|Sip.Body|0) contains string in initial SIP INVITE body. For INVITE without body, the variable is 'undefined'. The variable session.connection.record (session.connection.record|Record.Status|0) will hold the status of only IVR-Recording, it does not apply for FCR nor the recordings initiated using record tag in VXML.

Draft Option

session_vars_Draft

Default Value: session.connection.local.uri|LOCALURI|1|session.connection.remote.uri|REMOTEURI|1|session.connection.originator|ORIGIN|1|session.connection.protocol.name|PROTOCOLNAME|0|session.connection.protocol.version|PROTOCOLVERSION|0|session.connection.protocol.sip.headers|Sip.Invite|6|session.connection.protocol.sip.headers.originalcase|Sip.Invite.originalcase|6|session.connection.redirect|REDIRECTHEADER|7|session.connection.callidref|CALLIDREF|1|session.vendor_name.instance.parent|PARENT|1|session.connection.ocn|OCN|1|session.connection.rdnis|RDNIS|1|session.connection.rreason|RREASON|1|session.connection.uuid|XGENESYSCALLUUID|1|session.connection.dn|IVRPORT|1|session.vendor_name.cs.username|XGENESYSCSUSERNAME|1|session.vendor_name.cs.password|XGENESYSCSPASSWORD|1|session.connection.record|Record.Status|0
Valid Values: Please specify a '|' separated list of session variables according to the parameter description.
Changes Take Effect: At start/restart


Each session variable entry is composed of three components. The first component is the session variable name as exposed within VoiceXML. The second component is the variable name sent back from the Call Manager. The third component indicates either whether the session variable will be included in the request for the initial page URL (0 = do not include, 1 = include in GET, 2 = include in POST, 3 = include in GET and POST), or the type of array of the session variable (6 = associative array, 7 = array specific for draft-burke). This is a '|' delimited list. Besides the default variables, session.connection.protocol.sip.body (session.connection.protocol.sip.body|Sip.Body|0) contains string in initial SIP INVITE body. For INVITE without body, the variable is 'undefined'. The variable session.connection.record (session.connection.record|Record.Status|0) will hold the status of only IVR-Recording, it does not apply for FCR nor the recordings initiated using record tag in VXML.

This page was last edited on December 17, 2021, at 14:19.
Comments or questions about this documentation? Contact us for support!