API Message Reference

TR - Transfer Request

Layer Agent
Direction To CallGem
Type of Service CG
Interface ID AG
Message Purpose The agent or the agent application sends this message to initiate a call transfer.
Example TR\CNTest\ANFred\A2Joe\BL
Explanation Fred requests to do a blind call transfer to Joe.
Notes The Transfer Request [TR] message initiates a call transfer from the agent identified by the AN parameter to the agent identified by the A2 parameter. The agent identified by the AN parameter must be in a call. Calls can be transferred between agents on the same campaign, or to any agent logged into the system campaign. If the agent is on the system campaign and the transfer comes from an inbound or outbound ACD campaign, for accounting purposes the system campaign agent is moved to the ACD campaign for the duration of the call.

Types of Call Transfers

For information on the different types of call transfers please read the sections on Blind Transfers, Screened Transfers and Three Party Conference. See Call Transfer and Conference

Parameters
Code Name Type Mandatory? Min Val Max Val Description
A2 SecondAgent string false 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
AE AgentExtensionIdentifier string false 1 120 Alternative method for specifying transferee agent.
AN AgentIdentifier string 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
BL BlindTransfer boolean false 0 0 Defaults to screened transfer.
C3 Conference3 boolean false 0 0 3 Party conference flag. Setting this parameter turns the transfer into a 3-party conference
C4 ModifiedConference boolean false 0 0 Modified 3 Party conference flag. Setting this parameter turns the transfer into an agent conference followed by a 3-party conference
C5 ModifiedConference2 boolean false 0 0 From V10.6.147 - Modified 3 Party conference flag. Setting this parameter turns the transfer into a 3-party conference with the respondent initially put on hold
CL CallingLineIdentity string false 1 80 From V10.6.255 - The CLI to be presented when this number is dialed. Any value passed here must be a valid address terminating to your equipment.
CN CampaignName string 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
DT Data struct false 1 128000 Use this parameter to pass data to the agent application on connect to an agent.
EX ExternalAddress string false 1 80 Used in place of the AE parameter to indicate that the transfer is to an external number and to specify the transferee agent extension.
GA GroupAddress string false 1 80 If specified, the queue (on the system campaign) to transfer the call to. Must be a valid group address.
This parameter is alphanumeric.
MD MediaData string false 1 128000 From V10.7.324 - Data used to build up conversation history for a session
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 to transfer the call associated with the current active login session. User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
RI RingTimeout int false 12 600 Value range is from 12 to 600 seconds.

This parameter sets the Ring No Answer timeout for the transfer recipient.

SA SpoofAgent boolean false 0 0 If specified, along with an agent extension, indicates that an agent is to be spoofed for the transfer
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