Function:

Retrieves the specified held call.

Parameters:

HoldString:

The PBX string used to unhook. This parameter is used only for a Voice Modem. If the current line is a Voice Board, it will be ignored, and you should set the PBX string for Hook in the TSP configuration dialog for PBX strings. In most PBXs, "!", which mean a hool-flash, is often a part of the hold string. A hook-flash means a quick click on the hook of the phone. The duration of the hook-flash is determined by the PBX to which your telephone line is linked. If the duration of the Hook-Flash is too long, it will drop the call; If it is too short, it does not take effect. If you are using a Voice Board, you should set the duration of the Hook-Flash in the TSP configuration dialog.If you are using a Voice Modem, you can use SetHookFlashDuration to set the duration.

Description:

The call on hold is temporarily disconnected allowing the application to use the line device for making or answering other calls. The Hold function performs a so-called "hard hold" of the specified call (as opposed to a "consultation call"). A call on hard hold typically cannot be transferred or included in a conference call, but a consultation call can.

To hold a call, you should have the following configuration:

1.A small PBAX in you company or the big PBX from the TeleCom.

Your PBAX should have hold function. If you are using the telephone directly from PBX of the TeleCom, you should make sure that hold service is offered for you.

2.A PC with A Voice Modem or a Voice Board plugged in.

The line ports of Voice Modem or Voice Board should be linked to the inner port of the PBAX or PBX. And the parameters like the Hook-Flash String, Hook-Flash duration should be set properly.

Dependencies:

The line should be in connected status.

Events Raised:

None

Relevances:

CompleteTransfer, CancelTransfer,BlindTransfer,Hold,SwapHold