API Message Reference

HA - Hold Acknowledge

Layer	Agent
Direction	From CallGem
Type of Service	CG
Interface ID	AG
Message Purpose	This message is sent in response to a Request Hold [RH] message. If the RH message was valid, Softdial CallGem instructs the telephony layer to put the call on hold or retrieve. Once the telephony layer has attempted this, the result of the operation is fed back to the agent via the Hold Acknowledge [HA] message.
Example	HA\CNCustCare\AN2\ON\RS2
Explanation	The request to put a call on hold for the agent with identifier 2 on the CustCare campaign has failed due to a telephony error.
Notes	Related Links: Hold Acknowledge [HA] - Telephony to CallGem

Parameters
Code	Name	Type	Mandatory?	Min Val	Max Val	Description
AN	AgentIdentifier	string	true	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 / \ : * ? " < > | & % + ! ' ;
ON	OnOff	boolean	false	0	0	If specified, the call will be put on hold. If not specified, the call will be retrieved from hold.
RS	ResourceStatus	int	true	0	4	This parameter may have the value 0, 1 or 2.: 0 Respondent on hold/retrieved from hold as directed. 1 Failed - respondent went on hook 2 Failed due to a telephony error.
TD	TenantDescriptor	string	false	1	80	This parameter is alphanumeric and identifies to which tenant this message applies.
WH	WhoAck	string	false	0	8	From V10.6.147 - Bit Flag of who to put on hold (customer or second agent)