Avaya Client Services API Reference (Windows)
Avaya Client Services API Reference (Windows)
Avaya.ClientServices
CallFeatureService Class
CallFeatureService Properties
CallFeatureService Methods
CallFeatureService Events

# CallFeatureService Class

The CallFeatureService object is accessible from the User object, providing access to additional business communication features.
Inheritance Hierarchy
System
Object
Avaya.ClientServices
CallFeatureService

Namespace: Avaya.ClientServices
Assembly: AvayaClientServices (in AvayaClientServices.dll) Version: 550.0.60.0
Syntax
C#
Copy

    public class CallFeatureService

The CallFeatureService type exposes the following members.

Properties

| Name | Description
--- | --- | ---
| AutoCallbackCapability | A capability object indicating whether the auto callback feature is available.
| AutoCallbackEnabled | A Boolean value indicating whether the auto callback feature is enabled.
| AutoCallbackList | The list of outstanding auto-callback destinations.
| AvailableAutodials | Returns the list of available auto-dials.
| AvailableBusyIndicators | Returns the list of available busy indicators.
| AvailableFeatures | Returns the list of available call features.
| AvailableHuntGroupBusyPositionFeatures | Returns the list of configured hunt-group-busy-position feature buttons for the user.
| BlockCallingPartyNumberCapability | A capability object indicating whether the block calling party number feature is available.
| CallForwardingBusyNoAnswerCapability | A capability object indicating whether the call forwarding busy-no-answer feature is available for the user's local extension.
| CallForwardingBusyNoAnswerDestination | The call forwarding busy-no-answer destination the user's local extension.
| CallForwardingBusyNoAnswerEnabled | A Boolean value indicating whether the call forwarding busy-no-answer feature is enabled for the user's local extension.
| CallForwardingCapability | A capability object indicating whether the call forwarding feature is available for the user's local extension.
| CallForwardingDestination | The call forwarding destination the user's local extension.
| CallForwardingEnabled | A Boolean value indicating whether the call forwarding feature is enabled for the user's local extension.
| DirectedCallPickupCapability | A capability object indicating whether the directed call pickup feature is available.
| EC500Capability | A capability object indicating whether the EC500 feature is available.
| EC500Enabled | A Boolean value indicating whether the EC500 feature is enabled.
| EnhancedCallForwardingCapability | A capability object indicating whether the enhanced call forwarding feature is available for the user's local extension.
| EnhancedCallForwardingStatus | The Enhanced Call Forwarding status for user's local extension.
| ExclusionCapability | A capability object indicating whether the exclusion feature is available.
| ExtendCallCapability | A capability object indicating whether the extend call feature is available.
| ExtendedGroupCallPickupCapability | A capability object indicating whether the extended group call pickup feature is available.
| GroupCallPickupCapability | A capability object indicating whether the group call pickup feature is available.
| InternalTwinningEnabled | A Boolean value indicating whether the internal twinning feature is enabled.
| IsMaliciousCallTraceActive | A Boolean value indicating whether Malicious Call Trace feature is activated.
| IsServiceAvailable | Returns true if the Call Feature Service is available, false otherwise.
| LimitCallsCapability | A capability object indicating whether the Limit Number of Concurrent Calls feature is available.
| MaliciousCallTraceCapability | Returns an indication as to whether Malicious Call Trace feature is available for incoming active call.
| NoHoldConferenceCancelCapability | Returns an indication as to whether No Hold Conference feature can be canceled.
| NoHoldConferenceCapability | Returns an indication as to whether No Hold Conference feature is available for active call.
| NoHoldConferenceDestination | The destination extension for No Hold Conference feature button.
| ParkCallCapability | A capability object indicating whether the call park feature is available.
| ParkCallWithSlotCapability | Returns an indication as to whether the user is able to park call using park slot.
| PriorityCallCapability | A capability object indicating whether the priority call feature is available.
| SendAllCallsCapability | A capability object indicating whether the send all calls feature is available for the user's local extension.
| SendAllCallsEnabled | A Boolean value indicating whether the send all calls feature is enabled for the user's local extension.
| SendNNCapability | Returns an indication as to whether the user is able to invoke the send-nn feature.
| ServiceObservingCapability | Gets an indication as to whether service observing is available.
| TeamButtons | Returns the available team buttons.
| UnblockCallingPartyNumberCapability | A capability object indicating whether the unblock calling party number feature is available.
| UnparkCallCapability | A capability object indicating whether the call unpark feature is available.
| UnparkCallWithSlotCapability | Returns an indication as to whether the user is able to unpark call using park slot.
| WhisperPageCapability | A capability object indicating whether the whisper page feature is available.

Top
Methods

| Name | Description
--- | --- | ---
| ActivateMaliciousCallTrace | Activate Malicious Call Trace feature for incoming active call.
| BlockCallingPartyNumber | Starts a call to the specified destination with the user's calling party number information blocked if the call is made over a trunk.
| CancelExtendCall | Cancels a pending extension of the active call to the off-pbx destinations configured for the user's extension.
| CancelNoHoldConference | Cancels the No Hold Conference invocation.
| ChangeServiceObservingMode(ServiceObservingMode, CallFeatureService FeatureCompletionHandler) | Obsolete. Change the mode of service observing session.
| ChangeServiceObservingMode(ServiceObservingMode, CallFeatureService ServiceObservingCompletionHandler) | Change the mode of service observing session.
| ClearCrisisAlert | clears crisis alert for the watcher.
| CompleteCallPreemption | Completes call preemption after user acknowledges the continuous preemption tone.
| DirectedCallPickup | Picks up a call ringing at the specified extension.
| EnableAutoCallback(Boolean, CallFeatureService FeatureCompletionHandler) | Enables an automatic callback for the last call if it received a busy signal or was unanswered.
| EnableAutoCallback(Boolean, String, CallFeatureService FeatureCompletionHandler) | Enables or disables automatic callback for the specified destination. Use this method only if AutoCallback destination is editable (IsDestinationExtensionEditable), otherwise use EnableAutoCallback(Boolean, CallFeatureService FeatureCompletionHandler) method.
| EnableCallForwarding(Boolean, String, CallFeatureService FeatureCompletionHandler) | Enables or disables forwarding of all calls to the specified destination.
| EnableCallForwarding(String, Boolean, String, CallFeatureService FeatureCompletionHandler) | Enables or disables forwarding of all calls to the specified destination for another extension.
| EnableCallForwardingBusyNoAnswer(Boolean, String, CallFeatureService FeatureCompletionHandler) | Enables or disables forwarding of calls that receive a busy signal or are not answered to the specified destination.
| EnableCallForwardingBusyNoAnswer(String, Boolean, String, CallFeatureService FeatureCompletionHandler) | Enables or disables forwarding of calls that receive a busy signal or are not answered to the specified destination for another extension.
| EnableEC500(Boolean, CallFeatureService FeatureCompletionHandler) | Enables or disables EC500.
| EnableEC500(Boolean, String, CallFeatureService FeatureCompletionHandler) | Enables EC500 with the mobile phone number provided or disables EC500. Use this method only if EC500 destination is editable (IsDestinationExtensionEditable), otherwise use EnableEC500(Boolean, CallFeatureService FeatureCompletionHandler) method.
| EnableExclusion | Enables or disables exclusion for the active call.
| EnableSendAllCalls(Boolean, CallFeatureService FeatureCompletionHandler) | Enables or disables sending all calls to coverage.
| EnableSendAllCalls(String, Boolean, CallFeatureService FeatureCompletionHandler) | Enables or disables sending all calls to coverage for another extension.
| ExtendCall | Extends the active call to the off-pbx destinations configured for the user's extension, namely EC500.
| ExtendedGroupCallPickup | Picks up a call for the specified pickup group.
| GetCallForwardingBusyNoAnswerCapability | Retrieves the call forwarding busy no answer feature capability for the specified extension.
| GetCallForwardingBusyNoAnswerDestination | Retrieves the call forwarding busy-no-answer destination for the specified extension.
| GetCallForwardingCapability | Retrieves the call forwarding feature capability for the specified extension.
| GetCallForwardingDestination | Retrieves the call forwarding destination for the specified extension.
| GetCallRecordingCapabilityForActionType | Retrieves call recording capability for the specified call recording action type.
| GetCrisisAlert | Returns crisis alert details.
| GetEnhancedCallForwardingCapability | Retrieves the enhance call forwarding capability for the specified extension.
| GetEnhancedCallForwardingStatus | Retrieves the enhance call forwarding status for the specified extension.
| GetFeatureCapability | Returns a capability object indicating whether it is possible to invoke the specified call feature.
| GetFeatureStatusForFeature | Returns the status of the feature specified by the FeatureParameters object.
| GetHuntGroupBusyPositionCapability | Retrieves the hunt-group-busy-position capability for the specified hunt group number.
| GetSendAllCallsCapability | Retrieves send all call capability for the specified extension.
| GetServiceObservingStatusParameters | Returns Service observing feature status parameters.
| GroupCallPickup | Picks up a call for the user's pickup group.
| InvokeFeature(FeatureType, CallFeatureService FeatureCompletionHandler) | Invokes a feature that takes no feature invocation parameters.
| InvokeFeature(FeatureType, FeatureInvocationParameters, CallFeatureService FeatureCompletionHandler) | Invokes a feature that requires parameters.
| InvokeSendNNCall | Initiates/places a call to the remote address with send-nn. The call will be placed with the specified extension as the caller's number. Use this method only if FeatureMode is transient, otherwise use the SetSendNNEnabled(Boolean, String, CallFeatureService FeatureCompletionHandler) method.
| IsAutoCallbackEnabled | A Boolean value indicating whether the auto callback feature is enabled for the specified destination. Use this method only if AutoCallback destination is editable (IsDestinationExtensionEditable), otherwise use AutoCallbackEnabled property.
| IsCallForwardingBusyNoAnswerEnabled | Indicates if the call forwarding busy no answer feature is enabled for the specified extension.
| IsCallForwardingEnabled | Indicates if the call forwarding feature is enabled for the specified extension.
| IsFeatureAvailable | Determines if a specific feature is available.
| IsSendAllCallsEnabled | Indicates if the send all calls feature is enabled.
| LimitCalls | Enables or disables Limit Number of Concurrent Calls feature.
| MakeNoHoldConference | Start No Hold Conference for active call, or add new participant to existing conference.
| MoveCall | Perform a Call Handover to move the active call to the user's twin clients.
| ParkCall | Parks the active call.
| ParkCallToSlot | Parks the active call to a park slot. A parked call may later be unparked from another extension using the park slot.
| PerformCallRecordingWithActionType | Performs call recording operation with specific action type.
| PriorityCall | Starts a priority call to the specified destination.
| RetrieveCall | Perform a Call Handover to retrieve the active call from a user's twin clients.
| SetEnhancedCallForwardingStatus(EnhancedCallForwardingStatus, CallFeatureService FeatureCompletionHandler) | Sets the Enhanced Call Forwarding status for the user's local extension.
| SetEnhancedCallForwardingStatus(String, EnhancedCallForwardingStatus, CallFeatureService FeatureCompletionHandler) | Sets the Enhanced Call Forwarding status for another extension.
| SetHuntGroupBusyPositionEnabled | Enables or Disables Hunt Group Busy Position feature for a specified hunt group number.
| SetPersonalizedLabelForFeature | Updates the feature button with personalized label given by user.
| SetSendNNEnabled | Enables or disables send-nn for the specified extension. Calls will be placed with the specified extension as the caller's number. Use this method only if FeatureMode is permanent, otherwise use the InvokeSendNNCall(String, String, CallFeatureService FeatureCompletionHandler) method.
| StartServiceObserving(String, ServiceObservingType, Int32, CallFeatureService FeatureCompletionHandler) | Obsolete. Starts service observing.
| StartServiceObserving(String, ServiceObservingType, Int32, CallFeatureService ServiceObservingCompletionHandler) | Starts service observing.
| StopCoachingSession(CallFeatureService FeatureCompletionHandler) | Obsolete. Stop coaching and move the service observing session to previous mode.
| StopCoachingSession(CallFeatureService ServiceObservingCompletionHandler) | Stop coaching and move the service observing session to previous mode.
| StopServiceObserving(CallFeatureService FeatureCompletionHandler) | Obsolete. Stops service observing.
| StopServiceObserving(CallFeatureService ServiceObservingCompletionHandler) | Stops service observing.
| UnblockCallingPartyNumber | Starts a call to the specified destination with the user's calling party number information unblocked if it would normally be blocked.
| UnparkCall(CallFeatureService FeatureCompletionHandler) | Unparks a call previously parked at the user's extension.
| UnparkCall(String, CallFeatureService FeatureCompletionHandler) | Unparks a call previously parked at the specified extension.
| UnparkCallFromSlot | Unparks the call from a park slot.
| UpdateAutodial | Sends out a request to update a configured Autodial button.
| WhisperPage | Starts a whisper page to another user that is on an active call.

Top
Events

| Name | Description
--- | --- | ---
| AutoCallbackListChanged | Occurs when the list of outstanding auto-callback destinations is changed.
| AutoCallbackStatusChanged | Occurs when the status of the auto callback feature has changed.
| BusyIndicatorChanged | Occurs when the busy indicator status has changed.
| CallFeatureServiceAvailable | Occurs when the call feature service becomes available.
| CallFeatureServiceUnavailable | Occurs when the call feature service becomes unavailable.
| CallForwardingBusyNoAnswerStatusChanged | Occurs when the status of the call forwarding feature has changed due to user Busy/NoAnswer configuration.
| CallForwardingStatusChanged | Occurs when the status of the call forwarding feature has changed.
| CallPickupAlertStatusChanged | Occurs when the status of the enhanced call pickup feature has changed. The members of pickup group are notified on change of status.
| CrisisAlertStatusChanged | Occurs when the status of the crisis alert feature has changed. The status can also be retrieved using GetCrisisAlert method.
| EC500StatusChanged | Occurs when the status of the EC500 feature has changed.
| EnhancedCallForwardingStatusChanged | Occurs when the status of the enhanced call forwarding feature has changed.
| FeatureCapabilityChanged | Occurs when the capability of a feature has changed.
| FeatureListChanged | Occurs when the feature list changes.
| FeatureStatusChanged | Occurs when the status of a feature has changed.
| IncomingTeamButtonCallAdded | Occurs when the monitored station has an incoming ringing call. The Team Button notification alert status depends on ring type.
| IncomingTeamButtonCallRemoved | Occurs when the incoming call to monitored station stops ringing.
| IncomingTeamButtonCallUpdated | Occurs when the monitored station updated an incoming ringing call. The Team Button notification alert status depends on ring type.
| MaliciousCallTraceStatusChanged | Occurs when the Malicious Call Trace status is changed (on/off). Feature status is changed to ON when Malicious Call Trace controller took control over a malicious call trace. Feature status is changed to OFF when Malicious Call Trace controller deactivated a malicious call trace.
| SendAllCallsStatusChanged | Occurs when the status of the send all calls feature has changed.
| SendNNStatusChanged | Occurs when the parameters of the send-nn feature have changed.
| ServiceObservingDisabled | An event that is raised when the agent service observing feature is disabled.
| ServiceObservingEnabled | An event that is raised when the agent service observing feature is enabled.
| ServiceObservingError | Obsolete. An event that reports an error received for service observing session.
| ServiceObservingStatusChanged | Occurs when the status of the service observing feature has changed. The status can also be retrieved using GetServiceObservingStatusParameters method.
| TeamButtonBusyStatusChanged | Occurs if the Team Button busy status is changed when the monitored station either dials or has an active call.
| TeamButtonForwardingStatusChanged | Occurs when the forwarding status of monitored station is changed.
| TeamButtonsChanged | Occurs when the available team buttons list are updated.

Top
Remarks
The CallFeatureService object provides a set of APIs that allow application developers to implement advanced SIP telephony features.

In general, administered features can be invoked depending upon the current state of the system.

The client application is notified about status updates on features reported by the call feature service through event handlers that the application has registered on the CallFeatureService object's events. These updates may be the result of local operations on the CallFeatureService object as well as remote changes initiated by either the service/server or other end users.

In order to retrieve a list of features, call AvailableFeatures property. This should be done after CallFeatureServiceAvailable event is received.

See Also

#### Reference

Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.