API Message Guide

LS - Login Status

Layer CTI
Direction To CallGem
Type of Service CG
Interface ID CT
Message Purpose Used to indicate the success or failure of the Switch Login [SL] message. This message is mandatory if using the Switch Login (SL) parameter in the Trunks Open [TO] message.
Example LS\CNCustCare\AN2\AE43\RS0
Explanation The switch is informing CallGem that the requested log in for agent with identifier 2 on extension number 43 on the 'CustCare' campaign was successful.
Notes
Parameters
Code Name Type Mandatory? Min Val Max Val Description
AE AgentExtensionIdentifier string true 1 120 Required by the telephony layer to give each agent extension a unique identifier.
AN AgentIdentifier string false 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
CN CampaignName string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
GD GatewayDial string false 1 160

Provides the address (typically a SIP: address) that another gateway in the same cluster needs to dial to route a call through to a nailed up agent.

This is passed back to other gateways via the SL message.

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.

RS ResourceStatus int true 0 4
0 Success
1 Failed - respondent on hook
2 Failed due to a telephony error.
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