API Message Reference

AA - Agent Available

Layer Agent
Direction To CallGem
Type of Service CG
Interface ID AG
Message Purpose This message requests CallGem to make the agent with the specified 'AN' parameter available to handle calls or media sessions.
Example AA\TDdefault\AN2
Explanation The agent with identification number 2 will be put into the predictive pool, and is then available immediately to take calls.
Notes This message is required after an Agent Login [AL] message to put an agent into a ready state to take calls.

Note that if the agent application sends an Agent Unavailable [AU] message, and then decides it wants to countermand that message, it must wait until it has received an Agent Free [AF] message from CallGem first. If it doesn't do this, then any Agent Available [AA] message sent for the agent before he has been set free will be treated as an error.

See Agent Work Flow

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 / \ : * ? " < > | & % + ! ' ;
GP GoPreview boolean false 0 0 Deprecated V10.7.28 - If this parameter is present, the agent will be made available as a preview agent.

If this parameter is not present, the agent will be put into the predictive pool.

QI UserIdentifier string false 1 80 From V10.7.28 - Identifies this endpoint login as part of a User session. If the User ID is specified, CallGem will treat this as a request to make all endpoint sessions that belong to the user available. User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
SK Skillset string false 1 4000 The set of skills being assigned to the agent for outbound predictive dialing pusposes. These take the form of a comma separated list of 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

 

Copyright © 2004 - 2019  Sytel Limited