API Message Reference

SL - Switch Login

Layer CTI
Direction From CallGem
Type of Service CG
Interface ID CT
Message Purpose This message asks the switch to log in an agent station.
Example SL\TDdefault\CNCustCare\AN2\AE42
Explanation CallGem is asking the switch to log in agent station 2 at extension 42, on the CustCare campaign.
Notes Pre-V10.7.1345 - If the Switch Login (SL) parameter has been used in the Trunks Open [TO] message, then the telephony layer must return a Login Status [LS] message informing CallGem of the success (or otherwise) of the login.

From V10.7.1345 - the Switch Login (SL) parameter in the Trunks Open [TO] message is deprecated. All media layers must support Switch Login [SL]/ Login Status [LS] message interchange.

The CL parameter was added in V10.5 to allow a calling line identifier to be included and then passed to the agent extension when logging an agent in.

Parameters
Code Name Type Mandatory? Min Val Max Val Description
AE AgentExtensionIdentifier string false 1 120 The address or extension number to use for the call to the agent.
AN AgentIdentifier string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
CL CallingLineIdentity string false 1 80 The CLI to be presented when this number is dialed. Any value passed here must be a valid address terminating to your equipment.
CN CampaignName string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
GD GatewayDial string false 1 160

The address provided by another gateway in its LS message to indicate how to connect to an agent who is nailed up on that gateway.

GI GatewayIdentifier string false 1 80 Parameter provided by user in AL message to guarantee sending the SL message to a telephony gateway, the agent will be logged in from the specified telephony gateway, to be used in configurations were MGC is present.
NU NailedUp boolean false 0 0 This parameter indicates that the agent will be nailed-up.
NX IdentifyNode string true 1 80 Identifies the telephony layer the message is being sent to.
RI NailupTimeout int false 10 60 The nailup timeout duration for the request.
SI SessionIdentifier string false 1 120 The Session Identifier of the call whose customer connection should be used as the new agent.
TD TenantDescriptor string false 1 80 This parameter is alphanumeric and identifies to which tenant this message applies.
TU TemporaryNailedUp boolean false 0 0 From V10.6.946 & V10.7.1175 - This parameter indicates that the agent will be only temporarily nailed-up.
VA VirtualAgent boolean false 0 0 This parameter indicates that the agent is a virtual agent.
YA AgentUniqueId string false 20 50 From V10.7.596 - The UUID reference for the agent. This can be used as an alternate form of reference for the agent in place of the AN parameter.
YS SessionUniqueId string false 1 80 From V10.7.1401 - Provides an internally generated unique session id for the call session identified in the SI parameter.

 

Copyright © 2004 - 2019  Sytel Limited