RH - Request Hold

Layer	CTI
Direction	From CallGem
Type of Service	CG
Interface ID	CT
Message Purpose	This message is a companion to the agent Request Hold [RH] - Agent to Dialer message. The telephony layer request means 'request that the respondent in the call session is put on hold'.
Example	RH\TDdefault\CNCustCare\SIABC001\WH1\ON
Explanation	A request has been made to put the call session with session identifier ABC001 on hold.
Notes	The ON parameter indicates whether the call is to be put on hold or retrieved from hold. The telephony layer should respond with the telephony form of the Hold Acknowledge [HA] message. Related Links: Request Hold [RH] - Agent to CallGem

Parameters

Code

Name

Type

Mandatory?

Min Val

Max Val

Description

CampaignName

string

true

User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;

OnOff

boolean

false

If specified, the call will be put on hold. If not specified, the call will be retrieved from hold.

SessionIdentifier

string

true

120

Either the TN or the SI parameter must be used to identify the called party. Session Identifiers.

TenantDescriptor

string

false

This parameter is alphanumeric and identifies to which tenant this message applies.

TelephoneNumber

string

false

Either the TN or the SI parameter must be used to identify the called party. Session Identifiers.

Who

string

false

From V10.5.330 / 10.6.147. Bit Flag of who to put on hold (see table below). See also Call Hold and Mute

0	Preserves backward compatibility (default)
1	Indicates that the RH message applies to the primary call connection
2	Indicates the RH message applies to the secondary call connection
4	Indicates the RH message applies to the main call connection
8	Used in conjunction with the 'ON' parameter to invert the current Hold configuration. e.g. RH\AN1\CNtest\WH8\ON - puts the secondary connection on hold and takes the primary connection off hold. RH\AN1\CNtest\WH8 - puts the primary connection on hold and takes the secondary connection off hold.