API Message Reference

LC - Line Connected

Layer CTI
Direction To CallGem
Type of Service CG
Interface ID CT
Message Purpose This message tells CallGem that a connect has been established by the switch on a specific trunk.
Example LC\CNCustCare\TN01992783287\TI26\OD1.00
Explanation The telephony layer is telling CallGem that a connection has been established for the telephone number 01992783287 on trunk 26, for the CustCare campaign.
Notes
Parameters
Code Name Type Mandatory? Min Val Max Val Description
AN AgentIdentifier string true 1 80 This parameter is mandatory if the campaign is using Switch-Determined Routing. Otherwise it must not be used.
CN CampaignName string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
DN DialedNumber string true 0 80 Mandatory when using inbound. This parameter is used to present DNIS or DDI information to CallGem so that it can route the call to the right campaign.
GI GatewayIdentifier string false 1 80 The Gateway Identifier parameter allows CallGem to do preference routing when ther telephony interface is a media gateway controller rather than a simple media gateway.

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

MA Machine boolean false 0 0 Optional parameter, used to indicate that the connected call is an answer machine (according to the AMD). Answer machines should only be passed through as connects if the call is launched with Detection Option 4.
MS Message string true 0 255 In an STG configuration, this parameter provides the connection details for the call e.g the serial number of the Aculab card, port number and call handle used.
OD OffhookDelay double false 0 9.99 Informs CallGem of any time passed between connection and CallGem receiving this Line Connected [LC] message, e.g. when answering machine detection is used.

Value range is between 0 and 9.99 secs. Default value of 0 is assumed if parameter is not present.

See also the Abandoned Call Delay (DE) parameter in the Overdial Tuning [OT] message.

PO PortIdentifier string false 1 80 Pass if the telephony layer is supporting the Port Free [PF] message.
SI SessionIdentifier string false 1 120 Either the TN or the SI parameter must be used to identify the called party.

Used to give each called party a unique key. If omitted, CallGem assumes this parameter to be the same as the TN parameter. 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 Either the TN or the SI parameter must be used to identify the called party. Session Identifiers.
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