ctiRetrieve

Description

ctiRetrieve requests that a held call at the Avaya IR port be retrieved.

Input

• Call ID - Call ID of the held call

  (Type: num)

Output

• Error Code - Variable where the error code from the CSTA_UNIVERSAL_FAILURE_CONF event will be populated (only if the operation fails)

  (Type: num)

Return values

The return code indicates whether the call was successfully retrieved.

If successful, the result is > 0, which indicates that the CTI DIP received a CSTA_RETRIEVE_CALL_ CONF event.

On failure, the result is <=0, which indicates that the call was not successfully retrieved.

Usage notes

This function is typically used only to recover from an error, for example, if the Avaya IR dials a busy number and the application needs to reconnect to the held party to inform them of the busy party.

© 2006 Avaya Inc. All Rights Reserved.