API Message Reference

MA - Move Agent

Layer Management
Direction To CallGem
Type of Service CG
Interface ID MA
Message Purpose This message is sent by the control application to CallGem to request that an agent be moved from one campaign to another.
Example MA\CNSales1\C2CustCare\ANFred\TXBL00000327
Explanation The agent named Fred is going to be moved from the Sales1 campaign to the CustCare campaign. This will take place over a period of time.
Notes For an overview of agent movement, see Moving Agents.

The Move Agent [MA] message now allows the user to specify priority. Users should note that PR1 and PR2 will lead to additional abandoned calls and therefore reduced outbound performance.

If either the original or the destination campaign are not running at the time of the Move Agent [MA] request, results will be according to the following table:


Original
campaign
running?
Destination
campaign
running?
Result
YesYes Move successful.

Agent will be made available automatically, with no Agent Available [AA] message required.
YesNoNo action taken.
NoNoAgent automatically logged out.

The Move Agent [MA] message logs the request in the message log for the original campaign.

Parameters
Code Name Type Mandatory? Min Val Max Val Description
AN AgentIdentifier string false 1 80 The identifier of agent to be moved. This parameter is mutually exclusive with the Move Campaign (MC), User Identifier (QI) and Group Address (GA) parameters.
BM BlendMove boolean false 0 0 From 10.7.1228 - Whether the move is as a result of a blending operation
C2 CampaignTwo string true 1 80 Indicates the campaign to which the agent is to be moved.
CN CampaignName string false 1 80 For Move Agent requests with the Move Campaign (MC) parameter set, this identifies the campaign whose logged-in agent endpoints are to be moved wholesale.
GA GroupAddress string false 1 80 If specified, the group of agents that are to be moved. This parameter is mutually exclusive with Agent Identifier (AN), User Identifier (QI) and Move Campaign (MC) parameters.
KH KeepHome boolean false 0 0 From V10.6.418 - Move the agent but keep the agent's home campaign as the current home campaign for the agent. This parameter is mainly used for blending applications.
MC MoveCampaign boolean false 0 0 From V10.6.378 - Moves all agents from campaign 1 to campaign 2. This parameter is mutually exclusive with the Agent Identifier (AN), Group Address (GA) and User Identifier (QI) parameters.
PR Priority int false 0 2 Priority to be used for requesting unavailable. Note that Priority 2 behaves as priority 1 for move agent.

For values, see the Priority (PR) parameter in the Agent Unavailable [AU] message.

QI UserIdentifier string false 1 80 From V10.7.338 - The identity of the user to be moved. This will have the effect of making move requests for each agent endpoint associated with the user. This parameter is mutually exclusive with the Move Campaign (MC), Group Address (GA) and Agent Identifier (AN) parameters.
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
TX TransactionIdentifier string true 1 87 Used by subsequent messages from CallGem to identify the corresponding request. Must be unique across all requests.

 

Copyright © 2004 - 2019  Sytel Limited