NCCEVN_CALL_RETRIEVED

(solicited) The application retrieved a call it placed on hold.

(unsolicited) A call was retrieved by this unsolicited event.

State transition

To active line state, from idle line state.

Associated function

nccRetrieveCall, nccAutomaticTransfer, unsolicited

Fields

Field

Description

callhd

Call handle.

Reason codes

Reason code

Description

NCC_DIS_xxx

Signifies that an automatic transfer failed. For a list of valid values, see NCCEVN_CALL_DISCONNECTED.

Details

NCCEVN_CALL_RETRIEVED indicates that a call on hold was retrieved either by the application or by a remote party. The call is now active. Since there is an active call on the line, the line state changes to active.

Call hold/retrieve is not supported by all protocols. NCC_CAP_HOLD_CALL in the capabilitymask returned by nccQueryCapability indicates if the current protocol supports this capability or not.

The application can invoke nccGetCallStatus to determine whether a call is on hold or not. If a call is on hold, the held field in the NCC_CALL_STATUS structure returned for that call contains a non-zero value.