API Message Reference

LO - Log Out

Layer Agent
Direction To CallGem
Type of Service CG
Interface ID AG
Message Purpose This message logs an agent out of the campaign they are working on.
Example LO\AN2
Explanation Agent 2 is logged out of the campaign he is working on.
Notes If the agent application intends to log an agent out, then this message should be sent immediately an Agent Unavailable [AU] request to CallGem has been acknowledged by an Agent Free [AF] response.

Agent 2's identification number is then available for other agents to use if desired.

Parameters
Code Name Type Mandatory? Min Val Max Val Description
AN AgentIdentifier string 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
CN CampaignName string 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
QI UserIdentifier string false 1 80 From V10.7.28 - Mutually exclusive with AN Parameter. If the user ID is specified, CallGem will treat this as a request log out the current active login session for the user. User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
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

 

Copyright © 2004 - 2019  Sytel Limited