API Message Reference

AF - Agent Free

Layer Agent
Direction From CallGem
Type of Service CG
Interface ID AG
Message Purpose This message tells the agent application that CallGem will treat the selected agent as unavailable to receive further calls with immediate effect.
Example AF\CNCustCare\AN2\UR0
Explanation CallGem is responding to a request to make the agent (with identifier 2) unavailable from an Agent Unavailable [AU] message, and will cease to dial on his behalf.
Notes This message is sent as soon as CallGem is able to release the agent. Please see Changing Campaign State and Changing Agent Status.
Last Changed Pre V9.2
Parameters
Code Name Type Mandatory? Min Val Max Val Description
AN AgentIdentifier string true 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 / \ : * ? " < > | & % + ! ' ;
FD FreeReasonDescription string false 1 80 The Free Reason Description is a short text explanation for the accompanying Free Reason. The Free Reason and Description are optional. They are also independent: either, both or neither may be provided. However as numeric values are simpler to report on it is envisaged that the Description will act as an assistant field to the Reason.The FD value may be optionally included in the Agent Unavailable [AU] message request
FR FreeReason int false 0 999999 The Free Reason is a user defineable numeric code value. It represents the an integer neumonic determining the reason why an agent went unavailable. For a description of the Free Reason a FD (Free Reason Description) is provided. The FR value may be optionally included in the Agent Unavailable [AU] message request
TD TenantDescriptor string false 1 80 This parameter is alphanumeric and identifies to which tenant this message applies.
UR UnavailableReason int true 1 11 This parameter gives the reason why the agent is going unavailable:
0Regular unavailable request by agent (or application managing the agent).
1Unavailable request by agent priority 1.
2Emergency unavailable request from agent.
3Made unavailable due to campaign suspend.
4Made unavailable due to campaign stop.
5Made unavailable because of automated call blend agent movement between campaigns.
6Made unavailable because of manual (supervisor driven) agent movement between campaigns.
7Made unavailable because of agent kill (also applies to socket disconnect).
8Made unavailable because campaign is closing and agent is being chained to another campaign.
9Made unavailable because of agent kill Priority 1 (Kill agent following completion of call).
10Made unavailable because of agent kill priority 0 (Kill agent but observe availability negotiation).
11Made unavailable because of scheduled callback.

 

Copyright © 2004 - 2019  Sytel Limited