The newCall method is issued for calls arriving at the VRU that are not under ICM script control. A Service Control dialog
is created by this function. The successful running of this function causes
the received data to run a VRU based script.
The newCall method is issued once during a call. If it is issued, then
the requestInstruction method is not issued.
If this request is successful, the ICM provides instructions in a reasonable
amount of time. If the instructions are not provided, a dialogueFailureEventSend
method is sent with a status code of E_TIMEOUT.
The DialedNumber is required. If the DialedNumber is not provided, the ICM fails
the request and causes a signal to the Java application to issue a dialogueFailureEventRecv
method and the returned status code E_INVALID_MESSAGE.
If the DialedNumber is not configured at the ICM, the Java application
is signaled to issue a dialogueFailureEventRecv and the returned status code
of E_INVALID_DIALED_NUMBER.
If the ICM cannot provide instructions because a script is not active
for the given call type, the Java application is signaled to issue a dialogueFailureEventRecv
and the returned status code E_NO_SCRIPT.
In all other fatal error conditions the Java application is signaled to
issue a dialogueFailureEventRecv and the returned status code E_UNSPECIFIED_FAILURE.
Syntax
CTICiscoReturn newCall(Integer ServiceID, String DialedNumber, String ANI,
String UserToUserInfo, String CalledNumber, String DNIS, CTICiscoCallVars
CallVariables);
Parameters
- Integer ServiceID
- The ID of the service to which this call is assigned.
- String DialedNumber
- The number that is used to determine the ICM call type. The maximum
length of characters in the string is 32.
- String ANI
- The Calling line ID of the caller. The maximum length of characters
in the string is 40. This parameter is optional.
- String UserToUserInfo
- The ISDN user-to-user information element. The maximum length of characters
in the string is 131. This parameter is optional.
- String CalledNumber
- The complete called number from the network. The maximum length of characters
in the string is 32. This parameter is optional.
- String DNIS
- The DNIS that is provided with the call. The maximum length of characters
in the string is 32. This parameter is optional.
- CTICiscoCallVars CallVariables
-
To set this property create a CTICiscoCallVars object and call the
relevant set method for the variables you wish to set.
- String CallVariable1
- Additional VRU information that is to be used when the ICM script
is run. Set by the setCallVariable1 method. The maximum length of characters
in the string is 40. This parameter is optional.
- String CallVariable...
- Additional VRU information that is to be used when the ICM script
is run. Set by the setCallVariable... method. The maximum length of characters
in the string is 40. This parameter is optional.
- String CallVariable10
- Additional VRU information that is to be used when the ICM script
is run. Set by the setCallVariable10 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. Set by the
setECCVarValueTag1 method. This parameter is optional.
- String ECCVarValueString1
- Call-related data. Set by the setECCVarValueString1 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. Set by the
setECCVarValueTag... method. This parameter is optional.
- String ECCVarValueString...
- Call-related data. Set by the setECCVarValueString... 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. Set by the
setECCVarValueTag5 method. This parameter is optional.
- String ECCVarValueString5
- Call-related data. Set by the setECCVarValueString5 method. 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. Set by the
setECCVarArrayTag1 method. This parameter is optional.
- Integer ECCVarArrayIndex1
- A numeric array index identifier. Set by the setECCVarArrayIndex1 method.
This parameter is optional.
- String ECCVarArrayString1
- Call-related data. Set by the setECCVarArrayString1 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. Set by the
setECCVarArrayTag... method. This parameter is optional.
- Integer ECCVarArrayIndex...
- A numeric array index identifier. Set by the setECCVarArrayIndex...
method. This parameter is optional.
- String ECCVarArrayString...
- Call-related data. Set by the setECCVarValueString... 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. Set by the
setECCVarArrayTag5 method. This parameter is optional.
- Integer ECCVarArrayIndex5
- A numeric array index identifier. Set by the setECCVarArrayIndex5 method.
This parameter is optional.
- String ECCVarArrayString5
- Call-related data. Set by the setECCVarArrayString5 method. The maximum
length of characters in the string is 210. This parameter is optional.
Return properties
- 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.