API Message Reference

HA - Hold Acknowledge

Layer	CTI
Direction	To CallGem
Type of Service	CG
Interface ID	CT
Message Purpose	This message is sent in response to CallGem sending the Request Hold [RH] message to the telephony layer.
Example	HA\CNCustCare\SI654321\ON\RS0
Explanation	The call with session identifier 654321 on the CustCare campaign has successfully been put on hold.
Notes	Related Links: Hold Acknowledge [HA] - CallGem to Agent

Parameters
Code	Name	Type	Mandatory?	Min Val	Max Val	Description
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.
SI	SessionIdentifier	string	true	1	120	Used to give each called party a unique key.
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
WH	WhoAck	string	false	0	8	From V10.6.147 - Bit Flag of who to put on hold (customer or second agent)
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.