API Message Reference

TS - Transfer Status

Layer CTI
Direction To CallGem
Type of Service CG
Interface ID CT
Message Purpose Used to indicate the success or failure of the Call Transfer [CT] message. This message is mandatory when using the Transfer Status [TS] parameter in the Trunks Open [TO] message.
Example TS\CNCustCare\TI20\AE43\RS0
Explanation The telephony layer is advising CallGem that the call transfer to agent extension 43 on campaign 'CustCare' has succeeded.
Notes
Parameters
Code Name Type Mandatory? Min Val Max Val Description
AE AgentExtensionIdentifier string false 1 120 Required by the telephony layer to give each agent extension a unique identifier. Not required if the transfer the result of a call overflow to an external address.
AN AgentIdentifier string false 1 80 From V10.6.390 - User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
CN CampaignName string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
RS ResourceStatus int true 0 4
0 Success
1 Failed - phone on hook
2 Failed - general telephony problem
SI SessionIdentifier string true 1 120 Session Identifier parameter
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
TQ TimeoutQueue boolean false 0 0 Indicates that the transfer has failed on account of queue timeout
YA AgentUniqueId string false 20 50 From V10.7.596 - The UUID reference for the agent. This can be used as an alternate form of reference for the agent in place of the AN parameter.
YS SessionUUID string false 20 50 From V10.7.596 - Each media session has a universally unique identifier assigned on creation. The UUID can be used by telephony layer messaging as an alternative unique form of reference to the SI parameter.

 

Copyright © 2004 - 2019  Sytel Limited