Cisco Cisco IP Contact Center Release 4.6.2 Installation Guide
Appendix A API Extensions
VLEngine HTTP API
A-2
Remote Silent Monitoring Installation and Administration Guide
VLEngine HTTP API
checkUserCredentials.jsp
Checks validity of user ID (i.e., the Cisco agent ID) and PIN. Called by VRU call
flow script (VXML, IP IVR, CVP).
flow script (VXML, IP IVR, CVP).
Parameters
userID: ID of user logging in.
pin: Password of user logging in.
outputFormat: Specifies format of returned data:
plain: Returned data contains no formatting. CREDENTIALS_VALID result
will be returned as simple text (i.e., CREDENTIALS_VALID), for example.
Appropriate for hand-written VXML scripts or anything that can perform a
HTML request and process the result directly.
will be returned as simple text (i.e., CREDENTIALS_VALID), for example.
Appropriate for hand-written VXML scripts or anything that can perform a
HTML request and process the result directly.
vxml: Data formatted in result variable of returned VXML document.
Returned page has an <exit> statement that specifies a result variable in its
namelist parameter, and which contains the return code for the operation.
Appropriate for IP IVR’s VoiceBrowser step.
Returned page has an <exit> statement that specifies a result variable in its
namelist parameter, and which contains the return code for the operation.
Appropriate for IP IVR’s VoiceBrowser step.
vxml-cvp: VXML output. Includes extra data usable by a CVP studio call
flow (specifies output as VXML sub-dialog, contains Audium tags, etc.).
flow (specifies output as VXML sub-dialog, contains Audium tags, etc.).
Returns
Parameter
Type
CREDENTIALS_VALID
Information supplied is valid
INVALID_USER_ID
Caller’s user ID is invalid
INVALID_USER_PIN
PIN is not valid for the user
NOT_A_SUPERVISOR
Agent userID is not a supervisor in CTI OS