requestInstruction

The requestInstruction method is issued for calls arriving at the VRU that are already under ICM script control. The successful running of this function causes data received to run a VRU based script.

The requestInstruction method should be issued only once during a call. If it is issued, then the newCall should not be issued.

If this request is successful, the ICM provides instructions in a reasonable amount of time. If the Instructions are not provided, a dialogueFailureEventSend is sent with a status code of E_TIMEOUT.

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 requestInstruction(Integer ServiceID, String CorrelationID, String ANI, String UserToUserInfo, String CalledNumber, String DNIS);

Parameters

Integer ServiceID

The ID of the service to which this call is attributed.

String CorrelationID

The Correlation ID that is provided by an INAP network. This parameter is optional.

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.

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.