API Message Reference

IC - Inbound Connect

Layer CTI
Direction To CallGem
Type of Service CG
Interface ID CT
Message Purpose This message notifies CallGem that an inbound call has been picked up by the telephony layer and is to be routed by CallGem.
Example IC\CNCustCare\SI4GHDD0014\TN01296381200\DN01234567890
Explanation An inbound call with session ID 4GHDD0014 has been picked up by the telephony layer and is to be routed by CallGem. The call originating address was 01296381200 and the destination address is 01234567890
Notes
Parameters
Code Name Type Mandatory? Min Val Max Val Description
CN CampaignName string false 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
DF DefaultOverflow int false 0 2 From V10.6.674 - Hint Default overflow behaviour. 0 = Reject call (default setting). 1 = Queue call. 2 = Overflow call. Note this behaviour only applies to incoming calls with a Hint Address (HE) parameter set.
DN DialedNumber string false 0 80 DNIS information for the inbound call. This information will be as presented by the network.
DT Data struct false 1 128000 Data parameter
GI GatewayIdentifier string false 1 80 The Gateway Identifier parameter allows CallGem to do preference routing when the telephony interface is a media gateway controller rather than a simple media gateway.

The MGC should advise CallGem which physical gateway the call and agent sessions are routed through by assigning each a symbolic name and passing this name as a parameter to the LC, IC and LS messages.

HE HintAddress string false 0 80 From V10.6.674 - Hint destination address parameter. This is used to hint to CallGem that the call should be be sent to a particular destination queue address.
IC IdentifyCTI string true 1 80 From V10.7.657 - Identifies the telephony layer (switch). See Multiple Switches.
MT MediaType string false 0 80 Media type parameter. If not specified this defaults to the default media type for the CTI layer.
SI SessionIdentifier string true 1 120 Used to give each called party a unique key. Inbound sessions must specify a Session ID. Session Identifiers.
TD TenantDescriptor string false 1 80 This parameter is alphanumeric and identifies to which tenant this message applies.
TK Token string false 1 80 Token parameter
TN TelephoneNumber string false 0 80 This is the CLI information presented with the call.
XA HintAgent string false 0 80 From V10.6.674 - Hint Agent parameter. This is used to hint to CallGem that the call should be routed to a particular agent
YO DisplayName string false 1 1024 From V10.7.657 - The name and other pertinent information related to the customer to be displayed on the agent desktop.
YS SessionUUID string false 20 50 From V10.7.596 - Each media session has a universally unique identifier assigned on creation. The UUID can be used by telephony layer messaging as an alternative unique form of reference to the SI parameter.

 

Copyright © 2004 - 2019  Sytel Limited