TAPI Hold Reversion and HUNT Feature

Hold Reversion :

The Hold Reversion feature allows a holding party to be notified about the HELD call after the hold reversion duration times out. The holding party gets audio and visible hold reversion notifications. The application can set the hold reversion event flag to receive the hold reversion notification from Cisco TSP. CallInfo and CallState of the call remains unchanged when a hold reversion event occurs and the LineCallDevSpecific event is sent to the application indicating the hold reversion if the application has enabled the hold reversion event flag.

Hunt List :

CiscoTSP supports lines and their devices included in the Hunt List and provides appropriate information for applications to understand that the call is offered through a Hunt Pilot. Hunt List can include more than one Line Group and each Line Group may have different call distribution algorithms. Irrespective of the algorithm used in the Line Groups, CiscoTSP provides consistent information to applications.
When call offered on the line is routed through Hunt Pilot, CiscoTSP provides Hunt Pilot Directory Number or Partition in LINECALLINFO::DEVSPECIFIC for Caller, Called, or Connected IDs. However, there will be no Hunt Pilot information for Redirection and Redirecting ID. Hunt Pilot name is not passed to LINECALLINFO::DEVSPECIFIC. There is no separate LineDevSpecific event to report the Hunt Pilot information, however, it is reported by existing event when caller, called, or connected id changes. Hunt List can also interact with Call Pickup feature. However, Hunt List broadcast feature is not supported while interacting with CallPickup feature. In this case, there will be noPickup notification for the broadcasted call. CTI or Cisco Unified Communications Manager fails the pickup request if the application tries to pickup a broadcast call in Hunt List.
When call is routed to Hunt List and offering is accepted by Line Group member, the called information becomes Hunt Pilot's information. After Line Group member answers the call, connected ID will shows the actual Line Group member information with Hunt Pilot information in LINECALLINFO::DEVSPECIFIC. In this case, both called and connected ID contains Hunt Pilot information.In case of a conference, Hunt Pilot Directory Number or Partition is presented if connected party's primary call is routed through Hunt List.

N.B: To support this feature, the application must negotiate line extension 0x00A0000 or above.

Hunt Pilot Connected Number :

In Cisco Unified Communications Manager 9.0, the support for hunt pilots is enhanced to expose the huntmember which has answered the call as the called party in a call involving a hunt pilot at the calling side. With this enhancement, when a user calls a hunt pilot HP and the call is answered by the hunt list Line group member LG1, TAPI exposes DNof the HuntMember as the ModifiedConnectedParty DN under devspecific part of linecallinfo under Call Party Normalization info structure. When this feature is disabled, the modifiedconnectedParty exposed is the HuntPilotDN. The HuntPilot Information is available in the devspecific part of linecallinfo(under HuntPilotInfo structure). There is no change in Huntpilot information for call scenarios involving huntpilot, when this feature is enabled from the information exposed when this is feature is disabled.

Backward Compatibility

This feature is backward compatible. It can be enabled on Huntpilot page Display Line Group Member DN as Connected Party. By default, this feature is disabled so that the existing applications are not affected.

Hunt Group Login Status :

This feature allows TSP applications to log a controlled device in and out of a hunt group. In addition, TSP applications can query a device for the hunt group login status.After the TSP application successfully logs in or logs out of a hunt group, the TSP application sends a phone
event to notify associated applications of the updated login status. If the request to change the status does not actually result in a status change (for example, if TSP tries to log a device into a hunt group, but the device was already logged in to that group) no notification is sent.

Interface Updates

To support this feature, two interfaces have been updated:
• To log in and log out of hunt groups, the CCiscoPhoneDevSpecificSetHuntGroupLoginStatus extension
has been added to the existing CCiscoPhoneDevSpecific interface. The new extension has an enum
mHuntGroupLoginStatus.
• To query the hunt group login status, a new extension Cisco_LineDevCaps_Ext000E0000 has been added to the existing LineGetDevCapsinterface. The new extension has a member variable of
DeviceHuntGroupLoginStatus.

N.B: 

• To log in and out of hunt groups, the application must negotiate line extension 0x000E0000 or above. The new line extension is added as a part of this feature.
• To make use of this feature, he application must open a TAPI phone device with minimum extension version 0x00030000.

Error Description

Hunt group logins are not supported with the following device types. Login requests return the
LINEERR_OPERATIONUNAVAIL error:

• DeviceTapiRoutePoint
• CtiRemoteDevice
• CtiSparkRemoteDevice

The range of enum values for Hunt Group Login status must fall within the range of 0 to 2. Otherwise, the request returns LINEERR_INVALPARAM. If the request to set the Hunt Group Login Status is in process and a second request is sent, the second request returns the LINEERR_PENDING_REQUEST error.