API Message Guide

XA - Transfer To Agent

Layer Agent
Direction From CallGem
Type of Service CG
Interface ID AG
Message Purpose Transfer to agent message - sends a message to a specified agent
Example CG:AG:XA\TDfoo\ANfromthisagent\A2tothatagent\DT<MagicXMLDocument xmlns="http://www.sytelco.com/SCC/CM"><r><EntryPoint Name="MyStepNamewithinthescript" /><c i="0" n="id" m="true" d="1" /><c i="1" n="tn" m="false" d="12345" /></r></MagicXMLDocument>
Explanation CallGem is forwarding a message from the agent 'fromthisagent' to agent 'tothatagent'. The message is contained in the DT parameter. In this example the DT parameter contains the element 'EntryPoint' indicating this message is intended to redirect or control a script (from the step identified by the 'Name' attribute) for an agent 'tothatagent' who is logged into Scripter. The Scripter server will process this message and will check for a script step named 'MyStepNamewithinthescript'. If it finds such a script step, Scripter server will:
  1. End the current step that the agent is on
  2. Update the script session's campaign data with the data values contained in the rest of the xml document (fields id and tn in the example above)
  3. Call the new script step
Notes The DT parameter extends the CM data parameter format within Scripter by adding an 'EntryPoint' element as part of the row. This identifies the step within the script to be invoked.
Parameters
Code Name Type Mandatory? Min Val Max Val Description
A2 AgentTo string

false

1 80 The agent from whom the message was sent.
AN AgentIdentifier string false 1 80 The agent being sent the message.
C2 CampaignTwo string false 1 80 The campaign name of the agent from which the message was sent.
CN CampaignName string true 1 80 Campaign name of the agent being sent the message.
DT Data string true 1 4000 The data or content of the message.
FT Focus boolean false 0 0 If passed, indicates that the endpoint to which this message relates has the input focus.
GA GroupAddress string false 1 80 Indicates the group to whose members the message should be broadcast.
SI SessionIdentifier string false 1 120 Identifies this session
TD TenantDescriptor string true 1 80 This parameter is alphanumeric and identifies to which tenant this message applies.
TK Token string false 1 80 Token parameter