ctiHold

Description

ctiHold requests that a call that is active at the Avaya IR port be placed on hold.

Input

• Call ID - The ID of the call to be placed on hold.

  (Type: num)

Output

• Error Code - Variable that is populated with an error code if the operation fails.

  (Type: num)

Return values

The return code indicates whether the call was successfully placed on hold.

If successful, the result is >0.

On failure, the result is <=0.

Usage notes

ctiHold is best used in conjunction with the ctiCallState function to determine the state of a call before it is placed on hold.

If an error is encountered, the CTI DIP will populate the Error Code field. The value will be of type CSTA_Universal_Failure_t.

© 2006 Avaya Inc. All Rights Reserved.