The runScriptRequest is issued to receive the script and related call information
that the ICM wants run for this call instance.
If the script that is to be run cannot be found, the Java application must
send a dialogueFailureConfSend with a status of E_INVALID_SCRIPT.
If the script cannot be run because of an invalid call variable, the Java
application must send a dialogueFailureConfSend with a status of E_CALL_VARIABLE1 …
E_CALL_VARIABLE10.
In any event, the Java application must send a runScriptResult or dialogueFailureConfSend
in response to the runScriptRequest.
Syntax
CTICiscoReturn runScriptRequest();
Parameters
There are no input parameters for this method.
Return properties
- Integer InvokeID
- An ID for this request that should be sent in the related runScriptResult
or dialogFailureConfSend. To extract this property, call the getInvokeID method
on the returned CTICiscoReturn object.
- String ScriptID
- The ID of the script that is to run on the VRU. To extract this property,
call the getScriptID method on the returned CTICiscoReturn object. The maximum
length of characters in the string is 40.
- String ScriptConfiguration
- A configuration string that is configured in the ICM to select static
script options. To extract this property, call the getScriptConfiguration
method on the returned CTICiscoReturn object. The maximum length of characters
in the string is 40.
- String ANI
- The Calling line ID of the caller. To extract this property, call the
getANI method on the returned CTICiscoReturn object. The maximum length of
characters in the string is 40. This parameter is optional.
- String CallerEnteredDigits
- Digits that the caller enters. To extract this property, call the getCallerEnteredDigits
method on the returned CTICiscoReturn object. The maximum length of characters
in the string is 40.
- CTICiscoCallVars CallVariables
-
To extract this property call the getCallVars method on the returned
CTICiscoReturn object. The following CallVariables are available by using
get methods in this CTICiscoCallVars object.
- String CallVariable1
- Additional VRU information that is sent to the VRU to be used when the
script is run. Extracted by the getCallVariable1 method. The maximum length
of characters in the string is 40. This parameter is optional.
- String CallVariable...
- Additional VRU information that is sent to the VRU to be used when the
script is run. Extracted by the getCallVariable... method. The maximum length
of characters in the string is 40. This parameter is optional.
- String CallVariable10
- Additional VRU information that is sent to the VRU to be used when the
script is run. Extracted by the getCallVariable10 method. The maximum length
of characters in the string is 40. This parameter is optional.
- Integer ECCVarValueTag1
- The numeric tag value by which this variable is identified. Extracted
by the getECCVarValueTag1 method. This parameter is optional.
- String ECCVarValueString1
- Call-related data. Extracted by the getECCVarValueString1 method. The
maximum length of characters in the string is 210. This parameter is optional.
- Integer ECCVarValueTag...
- The numeric tag value by which this variable is identified. Extracted
by the getECCVarValueTag... method. This parameter is optional.
- String ECCVarValueString...
- Call-related data. Extracted by the getECCVarValueString... method.
The maximum length of characters in the string is 210. This parameter is optional.
- Integer ECCVarValueTag5
- The numeric tag value by which this variable is identified. Extracted
by the getECCVarValueTag5 method. This parameter is optional.
- String ECCVarValueString5
- Call-related data. Extracted by the getECCVarValueString5 method on
this object to retrieve ECCVarValueString5. The maximum length of characters
in the string is 210. This parameter is optional.
- Integer ECCVarArrayTag1
- The numeric tag value by which this variable is identified. Extracted
by the getECCVarArrayTag1 method. This parameter is optional.
- Integer ECCVarArrayIndex1
- A numeric array index identifier. Extracted by the getECCVarArrayIndex1
method. This parameter is optional.
- String ECCVarArrayString1
- Call-related data. Extracted by the getECCVarArrayString1 method. The
maximum length of characters in the string is 210. This parameter is optional.
- Integer ECCVarArrayTag...
- The numeric tag value by which this variable is identified.Extracted
by the the getECCVarArrayTag... method. This parameter is optional.
- Integer ECCVarArrayIndex...
- A numeric array index identifier. Extracted by the getECCVarArrayIndex...
method. This parameter is optional.
- String ECCVarArrayString...
- Call-related data. Extracted by the getECCVarArrayString... method.
The maximum length of characters in the string is 210. This parameter is optional.
- Integer ECCVarArrayTag5
- The numeric tag value by which this variable is identified. Extracted
by the getECCVarArrayTag5 method. This parameter is optional.
- Integer ECCVarArrayIndex5
- A numeric array index identifier. Extracted by getECCVarArrayIndex5
method. This parameter is optional.
- String ECCVarArrayString5
- Call-related data. Extracted by the getECCVarArrayString5 method. The
maximum length of characters in the string is 210. This parameter is optional.
- Integer Status
- Returns an Integer value from the list of status codes that describes
the result of this request (see Table 3.) To extract this
property, call the getStatus method on the returned CTICiscoReturn object.