API Message Reference

PB - Play Busy

Layer CTI
Direction From CallGem
Type of Service CG
Interface ID CT
Message Purpose This message instructs the telephony layer to play a local busy signal to the specified agent.
Example PB\TDdefault\CNCustCare\AN2\AE120
Explanation A local busy signal is played to Agent 2 on the CustCare campaign.
Notes Nailed-up agents will not hear busy on preview calls to a busy called party or internal calls to a busy agent. On receipt of this message the telephony layer should play a DSP generated local busy signal to the agent's connection.
Parameters
Code Name Type Mandatory? Min Val Max Val Description
AE AgentExtensionIdentifier string true 1 120 Required by the telephony layer to give each agent extension a unique identifier.
AN AgentIdentifier string false 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 / \ : * ? " < > | & % + ! ' ;
DT Data string false 1 128000 From V10.6.913 & V10.7.1086 - Data parameter
TD TenantDescriptor string false 1 80 This parameter is alphanumeric and identifies to which tenant this message applies.
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.

 

Copyright © 2004 - 2019  Sytel Limited