Get_Route

This function is invoked after a Route_Request_Event to obtain the data that is sent from the ICM that relates to the route requested.

For more information on using ECC variables, see Expanded Call Context Variables.

SendData

CallID (number)
Obtained using the Get_CallID custom server function.
CrossRefID (number)
Set by the user to identify routing dialog.

ReceiveData

LabelType (number)
The type of label:
1
Refers to the destination to which the call should be routed.
2
Indicates that the caller should receive a busy signal.
3
Indicates that the caller should receive ring-no-answer.
4
Indicates that further processing of the call is required.
5
Indicates that the default routing action should be taken.
Label (string[48])
The destination to which the call should be routed.
CallVariable1 (string[40])
Additional information relating to the call.
CallVariable... (string[40])
Additional information relating to the call.
CallVariable10 (string[40])
Additional information relating to the call.
Status (number)
A value in the list of status codes that is given in Event Data Feed and Call Routing Interface Status Codes.
ECCVarValueTag1 (number)(optional)
The numeric tag value by which this variable is identified.
ECCVarValueString1(string[210])(optional)
Call related data.
ECCVarValueTag... (number)(optional)
The numeric tag value by which this variable is identified.
ECCVarValueString... (string[210])(optional)
Call related data.
ECCVarValueTag5 (number)(optional)
The numeric tag value by which this variable is identified.
ECCVarValueString5 (string[210])(optional)
Call related data.
ECCVarArrayTag1 (number)(optional)
The numeric tag value by which this variable is identified.
ECCVarArrayIndex1 (number)(optional)
A numeric array index identifier.
ECCVarArrayString1(string[210])(optional)
Call related data.
ECCVarArrayTag... (number)(optional)
The numeric tag value by which this variable is identified.
ECCVarArrayIndex (number)(optional)
A numeric array index identifier.
ECCVarArrayString... (string[210])(optional)
Call related data.
ECCVarArrayTag5 (number)(optional)
The numeric tag value by which this variable is identified.
ECCVarArrayIndex5 (number)(optional)
A numeric array index identifier.
ECCVarArrayString5 (string[210])(optional)
Call related data.
Note: If the Get_Route ReceiveData action times out, it is a good idea for the state table to issue Route_End_Event. This causes the routing request to be stopped and enables the state table to continue with normal call processing. The timeout might occur, for example, when the Peripheral Gateway (PG) does not retrieve the required call information from the ICM inside the specified time. In this condition, the state table is most likely to clean up the call and exit, having played the caller an appropriate message, because it is not possible to route the call as the caller has requested. Further attempts to retrieve the routing information from the PG are permitted, but the likelihood of these succeeding is low, given the initial failure.