Service Control Interface codes

Call Cleared causes

Table 1 lists the Call Cleared causes and associated codes.

Table 1. Call Cleared causes
Code	Cause
1	Normal completion
2	Call abandoned
3	Call Transferred
4	New Transaction
5	Busy
6	No answer
7	Maintenance
8	Net congestion
9	Net not obtainable
10	Reorder tone
11	Resources not available
12	Trunks busy

Label types

Table 2 lists the label types.

Table 2. Label types
Type	Label
1	Normal
2	Busy
3	Ring
4	Not supported
5	Default

Status codes

Table 3 lists the status codes.

Table 3. Status codes
Status code	Status name	Description
0	E_NO_ERROR	No error occurred.
1	E_INVALID_VERSION	The version number that was requested by the PG is not supported by the VRU.
2	E_SESSION_ALREADY_ACTIVE	The VRU already has an active communication session with a PG.
3	E_VRU_OFFLINE	The VRU is unavailable.
4	E_SESSION_NOT_ACTIVE	No session is active.
5	E_INVALID_DIALED_NUMBER	The dialed number that is specified is not known to the ICM.
6	E_EVENTS_NOT_SUPPORTED	The VRU does not support the Event Data Feed.
7	E_POLLING_NOT_SUPPORTED	The VRU does not support the Polled Data Feed.
8	E_ROUTING_NOT_SUPPORTED	The VRU does not support the Call Routing Interface.
9	E_TIME_SYNCH_NOT_SUPPORTED	The VRU does not support the Time Synchronization Interface.
10	E_TIMEOUT	A timeout has occurred.
11	E_PG_OFFLINE	The Peripheral Gateway is offline.
12	E_REQUEST_REFUSED	The request was refused because of a temporary condition.
13	E_ROUTING_NOT_AVAILABLE	The ICM routing service is not available.
14	E_ROUTE_NOT_ACCEPTED	The VRU did not accept the supplied route.
15	E_UNSPECIFIED_FAILURE	An unspecified error occurred.
16	E_INVALID_INVOKEID	An invalid InvokeID has been specified in a result or response message.
17	E_SERVICE _CTRL_NOT_SUPPORTED	A request was made to initialize the Service Control Interface to a VRU that does not support the interface.
18	E_NO_SCRIPT	An ICM Script has not been scheduled for the call type that the VRU is seeking instruction.
19	E_CALL_VARIABLE1	The VRU could not process a request because of invalid value in CallVariable1.
20	E_CALL_VARIABLE2	The VRU could not process a request because of invalid value in CallVariable2.
21	E_CALL_VARIABLE3	The VRU could not process a request because of invalid value in CallVariable3.
22	E_CALL_VARIABLE4	The VRU could not process a request because of invalid value in CallVariable4.
23	E_CALL_VARIABLE5	The VRU could not process a request because of invalid value in CallVariable5.
24	E_CALL_VARIABLE6	The VRU could not process a request because of invalid value in CallVariable6.
25	E_CALL_VARIABLE7	The VRU could not process a request because of invalid value in CallVariable7.
26	E_CALL_VARIABLE8	The VRU could not process a request because of invalid value in CallVariable8.
27	E_CALL_VARIABLE9	The VRU could not process a request because of invalid value in CallVariable9.
28	E_CALL_VARIABLE10	The VRU could not process a request because of invalid value in CallVariable10.
29	E_INVALID_SCRIPT	The Script ID specified in the RUN_SCRIPT_REQ message was invalid on the VRU.
30	E_INVALID_CALLID	The CallID that was specified in a Service Control request message is not valid on the VRU.
31	E_DUPLICATE_DIALOGUEID	The dialogue identifier that was specified in either a NEW_CALL or REQUEST_INSTRUCTION message was not unique.
32	E_INVALID_MESSAGE	This error code can be sent in response to any message that is received with missing required floating fields.
33	E_INVALID_DIALOGUEID	The DialogueID that was specified in a request message is no longer valid.
34	E_OPERATION_CANCELLED	The specified operation was successfully canceled by a cancel request.
35	E_OPERATION_NOT_CANCELLED	The specified operation could not be canceled by a cancel request.
121	E_NO_EVENTS_FOR_THIS_DIALOGUE	The state table issued a call as if the WaitEvent were successful and there were no waiting events from the view of the Custom Server.
122	E_REQUESTED_EVENT_DOES_NOT_MATCH	The requested event is not the next event to be delivered.
123	E_NEW_CALL_OR_REQ_INST_DUP	The state table attempted to issue more than one New_Call or Request_Instruction in the same call instance. Only one of the two can be issued. Not both or multiples of each.
124	E_DIALOGUE_NOT_ACTIVE	In the view of the ICM, the dialogue is no longer active.
125	E_NOT_IN_SIMULATION_MODE	This is returned to the state table when the Set Simulation Variables is issued, but the Cisco ICM custom server was loaded without the `-T` flag. The service writer can leave this call in the service and branch when this return code is received.
126	E_NON_SEQUENTIAL_SCRIPTS	This is returned to the state table when the Set Simulation Variables call has provided non sequential ScriptID fields. An example would be that ScriptID_1 is supplied, ScriptID_2 is left blank, and then ScriptID_3 is supplied.
127	E_MISSING_CONFIG_FIELDS	This is returned to the state table when the Set Simulation Variables has supplied a ScriptID but left the associated Config entry blank. Config entries are required when a ScriptID is supplied.
128	E_INVALID_SCRIPT_FLAGS	This is returned to the state table when the Set Simulation Variables has supplied non valid script flags. The valid values of the script flags are: 0 = No Action 1 = Cancel to be sent against the associated script 2 = Release to be sent against the associated script 3 = Connect to be sent against the associated Script 4 = Dialog Failure Event is sent against the associated script
129	E_INVALID_EVENT_CODE	This is returned to the state table when a non valid Event Code is supplied in the Report Event request.
130	E_NO_RUNSCRIPT	This is returned to the state table when a Run Script Request is issued by the state table, but the Cisco ICM custom server is not loaded with the `-V` flag.
131	E_NO_CONNECT	This is returned to the state table when a Run Script Request is issued by the state table, but the Cisco ICM custom server was not loaded with the `-W` flag.
132	E_NO_RELEASE	This is returned to the state table when a Run Script Request is issued by the state table but the Cisco ICM custom server is not loaded with the `-X` flag.
133	E_NO_CANCEL	This is returned to the state table when a Run Script Request is issued by the state table, but the Cisco ICM custom server is not loaded with the `-Y` flag.
134	E_NO_BLIND	This is returned to the state table when the Connect_To_Resource message is issued by the state table, but the Cisco ICM custom server is not loaded with the -Z flag.
136	E_INVALID_INSTANCE_NUMBER	The instance number associated with the call or the instance number specified in a Set_Instance_Number function call is invalid.

Status codes for a Java application

Table 4 lists the status codes for a Java application.

Table 4. Status codes for a Java application
Code	Event Type	Description
-70	UNKNOWN_ERROR	There is an unknown error. If this occurs, try stopping and restarting Blueworx Voice Response and Cisco ICM.
-71	MISSING_KEY	A required key (parameter) is missing from the request. If this occurs, try stopping and restarting Blueworx Voice Response and Cisco ICM.
-72	UNABLE_TO_GET_CALLID	A CallID cannot be obtained for the current application. If this occurs, try stopping and restarting Blueworx Voice Response and Cisco ICM.
-73	UNABLE_TO_GET_DIAGID	DialogueID cannot be obtained for the current application. If this occurs, try stopping and restarting Blueworx Voice Response and Cisco ICM.
-74	SOCKET_WRITE_FAILURE	The socket connection between the Cisco ICM custom server and the Java and VoiceXML environment has been dropped. Try stopping and restarting the Java voice response node and the Cisco ICM custom server. If a port other than the default port is being used, check that the same port number is specified in the Java configuration files as is used by the -J parameter (see Custom server parameters.)
-75	REQUEST_TIMED_OUT	A Cisco ICM request has timed out. If this error persists, try stopping and restarting Blueworx Voice Response and Cisco ICM.
-76	NO_SOCKET_CONNECTION	The socket connection between the Cisco ICM custom server and the Java and VoiceXML environment has been dropped. Try stopping and restarting the Java voice response node and the Cisco ICM custom server. If a port other than the default port is being used, check that the same port number is specified in the Java configuration files as is used by the -J parameter (see Custom server parameters.)
-77	WAIT_FOR_EVENT_TIMED_OUT	The timeout specified in the waitForEvent method has expired without any unsolicited messages arriving from the Cisco ICM.
-78	UNABLE_TO_GET_OHSL	Unable to open the custom server. Try restarting Blueworx Voice Response.
-79	UNABLE_TO_GET_CHSL	Unable to close the custom server. Try restarting Blueworx Voice Response.
-80	INVALID_PARAMETER	An incorrect parameter has been passed in. Check that all required parameters are specified and enter the parameter again.

Event codes

Table 5 lists the event codes.

Table 5. Event codes
Code	Event Type	Description
1	CONNECT_FAILURE	Indicates that a network failure occurred when attempting to connect the call.
2	BUSY	Indicates a BUSY condition at intended call destination.
3	NO_ANSWER	Indicates that a call was not connected to the target destination in the specified time-out or ring count.
4	ANSWER	Indicates that a call has connected to destination.
5	ABANDON	Indicates that a call disconnected after a NEW_CALL or REQUEST_INSTRUCTION message, but before receiving call handling instructions.
6	DISCONNECT	Indicates that a call has disconnected.

Unsolicited event codes

Table 6 lists the unsolicited event codes.

Table 6. Unsolicited event codes
Code	Event Type	Description
7	Run_Script_Request	Indicates that the ICM has issued a Run_Script_Request event in response to either a New_Call, Request_Instruction or New_Dialogue event. The state table should issue the Run_Script_Request custom server event in response to this to receive the data that has been sent by the ICM.
9	Connect	Indicates that the ICM has issued a CONNECT event. The state table should issue the Connect custom server event to receive the data that has been sent by the ICM.
12	Dialogue_Failure_Event	Indicates that the ICM has issued a Dialogue_Failure_Event. The state table should issue the Dialogue_Failure_Event_Recv in response to this event, to find the cause of the event.
19	Cancel	Indicates that the ICM has issued the Cancel event. The state table should issue the Cancel custom server event in response to this.
20	Release	Indicates that the ICM has issued the Release event. The state table should issue the Release custom server event in response to this.
22	Connect_To_Resource	Indicates that the ICM has issued the Connect To Resource event. The state table should issue the Connect To Resource custom server event in response to this.