Click or drag to resize

CallFeatureService Class

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

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

The CallFeatureService type exposes the following members.

Properties
  NameDescription
Public propertyAutoCallbackCapability
A capability object indicating whether the auto callback feature is available.
Public propertyAutoCallbackEnabled
A Boolean value indicating whether the auto callback feature is enabled.
Public propertyAutoCallbackList
The list of outstanding auto-callback destinations.
Public propertyAvailableAutodials
Returns the list of available auto-dials.
Public propertyAvailableBusyIndicators
Returns the list of available busy indicators.
Public propertyAvailableFeatures
Returns the list of available call features.
Public propertyAvailableHuntGroupBusyPositionFeatures
Returns the list of configured hunt-group-busy-position feature buttons for the user.
Public propertyBlockCallingPartyNumberCapability
A capability object indicating whether the block calling party number feature is available.
Public propertyCallForwardingBusyNoAnswerCapability
A capability object indicating whether the call forwarding busy-no-answer feature is available for the user's local extension.
Public propertyCallForwardingBusyNoAnswerDestination
The call forwarding busy-no-answer destination the user's local extension.
Public propertyCallForwardingBusyNoAnswerEnabled
A Boolean value indicating whether the call forwarding busy-no-answer feature is enabled for the user's local extension.
Public propertyCallForwardingCapability
A capability object indicating whether the call forwarding feature is available for the user's local extension.
Public propertyCallForwardingDestination
The call forwarding destination the user's local extension.
Public propertyCallForwardingEnabled
A Boolean value indicating whether the call forwarding feature is enabled for the user's local extension.
Public propertyDirectedCallPickupCapability
A capability object indicating whether the directed call pickup feature is available.
Public propertyEC500Capability
A capability object indicating whether the EC500 feature is available.
Public propertyEC500Enabled
A Boolean value indicating whether the EC500 feature is enabled.
Public propertyEnhancedCallForwardingCapability
A capability object indicating whether the enhanced call forwarding feature is available for the user's local extension.
Public propertyEnhancedCallForwardingStatus
The Enhanced Call Forwarding status for user's local extension.
Public propertyExclusionCapability
A capability object indicating whether the exclusion feature is available.
Public propertyExtendCallCapability
A capability object indicating whether the extend call feature is available.
Public propertyExtendedGroupCallPickupCapability
A capability object indicating whether the extended group call pickup feature is available.
Public propertyGroupCallPickupCapability
A capability object indicating whether the group call pickup feature is available.
Public propertyInternalTwinningEnabled
A Boolean value indicating whether the internal twinning feature is enabled.
Public propertyIsMaliciousCallTraceActive
A Boolean value indicating whether Malicious Call Trace feature is activated.
Public propertyIsServiceAvailable
Returns true if the Call Feature Service is available, false otherwise.
Public propertyLimitCallsCapability
A capability object indicating whether the Limit Number of Concurrent Calls feature is available.
Public propertyMaliciousCallTraceCapability
Returns an indication as to whether Malicious Call Trace feature is available for incoming active call.
Public propertyNoHoldConferenceCancelCapability
Returns an indication as to whether No Hold Conference feature can be canceled.
Public propertyNoHoldConferenceCapability
Returns an indication as to whether No Hold Conference feature is available for active call.
Public propertyNoHoldConferenceDestination
The destination extension for No Hold Conference feature button.
Public propertyParkCallCapability
A capability object indicating whether the call park feature is available.
Public propertyParkCallWithSlotCapability
Returns an indication as to whether the user is able to park call using park slot.
Public propertyPriorityCallCapability
A capability object indicating whether the priority call feature is available.
Public propertySendAllCallsCapability
A capability object indicating whether the send all calls feature is available for the user's local extension.
Public propertySendAllCallsEnabled
A Boolean value indicating whether the send all calls feature is enabled for the user's local extension.
Public propertySendNNCapability
Returns an indication as to whether the user is able to invoke the send-nn feature.
Public propertyServiceObservingCapability
Gets an indication as to whether service observing is available.
Public propertyTeamButtons
Returns the available team buttons.
Public propertyUnblockCallingPartyNumberCapability
A capability object indicating whether the unblock calling party number feature is available.
Public propertyUnparkCallCapability
A capability object indicating whether the call unpark feature is available.
Public propertyUnparkCallWithSlotCapability
Returns an indication as to whether the user is able to unpark call using park slot.
Public propertyWhisperPageCapability
A capability object indicating whether the whisper page feature is available.
Top
Methods
  NameDescription
Public methodActivateMaliciousCallTrace
Activate Malicious Call Trace feature for incoming active call.
Public methodBlockCallingPartyNumber
Starts a call to the specified destination with the user's calling party number information blocked if the call is made over a trunk.
Public methodCancelExtendCall
Cancels a pending extension of the active call to the off-pbx destinations configured for the user's extension.
Public methodCancelNoHoldConference
Cancels the No Hold Conference invocation.
Public methodChangeServiceObservingMode(ServiceObservingMode, CallFeatureServiceFeatureCompletionHandler) Obsolete.
Change the mode of service observing session.
Public methodChangeServiceObservingMode(ServiceObservingMode, CallFeatureServiceServiceObservingCompletionHandler)
Change the mode of service observing session.
Public methodClearCrisisAlert
clears crisis alert for the watcher.
Public methodCompleteCallPreemption
Completes call preemption after user acknowledges the continuous preemption tone.
Public methodDirectedCallPickup
Picks up a call ringing at the specified extension.
Public methodEnableAutoCallback(Boolean, CallFeatureServiceFeatureCompletionHandler)
Enables an automatic callback for the last call if it received a busy signal or was unanswered.
Public methodEnableAutoCallback(Boolean, String, CallFeatureServiceFeatureCompletionHandler)
Enables or disables automatic callback for the specified destination. Use this method only if AutoCallback destination is editable (IsDestinationExtensionEditable), otherwise use EnableAutoCallback(Boolean, CallFeatureServiceFeatureCompletionHandler) method.
Public methodEnableCallForwarding(Boolean, String, CallFeatureServiceFeatureCompletionHandler)
Enables or disables forwarding of all calls to the specified destination.
Public methodEnableCallForwarding(String, Boolean, String, CallFeatureServiceFeatureCompletionHandler)
Enables or disables forwarding of all calls to the specified destination for another extension.
Public methodEnableCallForwardingBusyNoAnswer(Boolean, String, CallFeatureServiceFeatureCompletionHandler)
Enables or disables forwarding of calls that receive a busy signal or are not answered to the specified destination.
Public methodEnableCallForwardingBusyNoAnswer(String, Boolean, String, CallFeatureServiceFeatureCompletionHandler)
Enables or disables forwarding of calls that receive a busy signal or are not answered to the specified destination for another extension.
Public methodEnableEC500(Boolean, CallFeatureServiceFeatureCompletionHandler)
Enables or disables EC500.
Public methodEnableEC500(Boolean, String, CallFeatureServiceFeatureCompletionHandler)
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, CallFeatureServiceFeatureCompletionHandler) method.
Public methodEnableExclusion
Enables or disables exclusion for the active call.
Public methodEnableSendAllCalls(Boolean, CallFeatureServiceFeatureCompletionHandler)
Enables or disables sending all calls to coverage.
Public methodEnableSendAllCalls(String, Boolean, CallFeatureServiceFeatureCompletionHandler)
Enables or disables sending all calls to coverage for another extension.
Public methodExtendCall
Extends the active call to the off-pbx destinations configured for the user's extension, namely EC500.
Public methodExtendedGroupCallPickup
Picks up a call for the specified pickup group.
Public methodGetCallForwardingBusyNoAnswerCapability
Retrieves the call forwarding busy no answer feature capability for the specified extension.
Public methodGetCallForwardingBusyNoAnswerDestination
Retrieves the call forwarding busy-no-answer destination for the specified extension.
Public methodGetCallForwardingCapability
Retrieves the call forwarding feature capability for the specified extension.
Public methodGetCallForwardingDestination
Retrieves the call forwarding destination for the specified extension.
Public methodGetCallRecordingCapabilityForActionType
Retrieves call recording capability for the specified call recording action type.
Public methodGetCrisisAlert
Returns crisis alert details.
Public methodGetEnhancedCallForwardingCapability
Retrieves the enhance call forwarding capability for the specified extension.
Public methodGetEnhancedCallForwardingStatus
Retrieves the enhance call forwarding status for the specified extension.
Public methodGetFeatureCapability
Returns a capability object indicating whether it is possible to invoke the specified call feature.
Public methodGetFeatureStatusForFeature
Returns the status of the feature specified by the FeatureParameters object.
Public methodGetHuntGroupBusyPositionCapability
Retrieves the hunt-group-busy-position capability for the specified hunt group number.
Public methodGetSendAllCallsCapability
Retrieves send all call capability for the specified extension.
Public methodGetServiceObservingStatusParameters
Returns Service observing feature status parameters.
Public methodGroupCallPickup
Picks up a call for the user's pickup group.
Public methodInvokeFeature(FeatureType, CallFeatureServiceFeatureCompletionHandler)
Invokes a feature that takes no feature invocation parameters.
Public methodInvokeFeature(FeatureType, FeatureInvocationParameters, CallFeatureServiceFeatureCompletionHandler)
Invokes a feature that requires parameters.
Public methodInvokeSendNNCall
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, CallFeatureServiceFeatureCompletionHandler) method.
Public methodIsAutoCallbackEnabled
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.
Public methodIsCallForwardingBusyNoAnswerEnabled
Indicates if the call forwarding busy no answer feature is enabled for the specified extension.
Public methodIsCallForwardingEnabled
Indicates if the call forwarding feature is enabled for the specified extension.
Public methodIsFeatureAvailable
Determines if a specific feature is available.
Public methodIsSendAllCallsEnabled
Indicates if the send all calls feature is enabled.
Public methodLimitCalls
Enables or disables Limit Number of Concurrent Calls feature.
Public methodMakeNoHoldConference
Start No Hold Conference for active call, or add new participant to existing conference.
Public methodMoveCall
Perform a Call Handover to move the active call to the user's twin clients.
Public methodParkCall
Parks the active call.
Public methodParkCallToSlot
Parks the active call to a park slot. A parked call may later be unparked from another extension using the park slot.
Public methodPerformCallRecordingWithActionType
Performs call recording operation with specific action type.
Public methodPriorityCall
Starts a priority call to the specified destination.
Public methodRetrieveCall
Perform a Call Handover to retrieve the active call from a user's twin clients.
Public methodSetEnhancedCallForwardingStatus(EnhancedCallForwardingStatus, CallFeatureServiceFeatureCompletionHandler)
Sets the Enhanced Call Forwarding status for the user's local extension.
Public methodSetEnhancedCallForwardingStatus(String, EnhancedCallForwardingStatus, CallFeatureServiceFeatureCompletionHandler)
Sets the Enhanced Call Forwarding status for another extension.
Public methodSetHuntGroupBusyPositionEnabled
Enables or Disables Hunt Group Busy Position feature for a specified hunt group number.
Public methodSetPersonalizedLabelForFeature
Updates the feature button with personalized label given by user.
Public methodSetSendNNEnabled
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, CallFeatureServiceFeatureCompletionHandler) method.
Public methodStartServiceObserving(String, ServiceObservingType, Int32, CallFeatureServiceFeatureCompletionHandler) Obsolete.
Starts service observing.
Public methodStartServiceObserving(String, ServiceObservingType, Int32, CallFeatureServiceServiceObservingCompletionHandler)
Starts service observing.
Public methodStopCoachingSession(CallFeatureServiceFeatureCompletionHandler) Obsolete.
Stop coaching and move the service observing session to previous mode.
Public methodStopCoachingSession(CallFeatureServiceServiceObservingCompletionHandler)
Stop coaching and move the service observing session to previous mode.
Public methodStopServiceObserving(CallFeatureServiceFeatureCompletionHandler) Obsolete.
Stops service observing.
Public methodStopServiceObserving(CallFeatureServiceServiceObservingCompletionHandler)
Stops service observing.
Public methodUnblockCallingPartyNumber
Starts a call to the specified destination with the user's calling party number information unblocked if it would normally be blocked.
Public methodUnparkCall(CallFeatureServiceFeatureCompletionHandler)
Unparks a call previously parked at the user's extension.
Public methodUnparkCall(String, CallFeatureServiceFeatureCompletionHandler)
Unparks a call previously parked at the specified extension.
Public methodUnparkCallFromSlot
Unparks the call from a park slot.
Public methodUpdateAutodial
Sends out a request to update a configured Autodial button.
Public methodWhisperPage
Starts a whisper page to another user that is on an active call.
Top
Events
  NameDescription
Public eventAutoCallbackListChanged
Occurs when the list of outstanding auto-callback destinations is changed.
Public eventAutoCallbackStatusChanged
Occurs when the status of the auto callback feature has changed.
Public eventBusyIndicatorChanged
Occurs when the busy indicator status has changed.
Public eventCallFeatureServiceAvailable
Occurs when the call feature service becomes available.
Public eventCallFeatureServiceUnavailable
Occurs when the call feature service becomes unavailable.
Public eventCallForwardingBusyNoAnswerStatusChanged
Occurs when the status of the call forwarding feature has changed due to user Busy/NoAnswer configuration.
Public eventCallForwardingStatusChanged
Occurs when the status of the call forwarding feature has changed.
Public eventCallPickupAlertStatusChanged
Occurs when the status of the enhanced call pickup feature has changed. The members of pickup group are notified on change of status.
Public eventCrisisAlertStatusChanged
Occurs when the status of the crisis alert feature has changed.
The status can also be retrieved using GetCrisisAlert method.
Public eventEC500StatusChanged
Occurs when the status of the EC500 feature has changed.
Public eventEnhancedCallForwardingStatusChanged
Occurs when the status of the enhanced call forwarding feature has changed.
Public eventFeatureCapabilityChanged
Occurs when the capability of a feature has changed.
Public eventFeatureListChanged
Occurs when the feature list changes.
Public eventFeatureStatusChanged
Occurs when the status of a feature has changed.
Public eventIncomingTeamButtonCallAdded
Occurs when the monitored station has an incoming ringing call. The Team Button notification alert status depends on ring type.
Public eventIncomingTeamButtonCallRemoved
Occurs when the incoming call to monitored station stops ringing.
Public eventIncomingTeamButtonCallUpdated
Occurs when the monitored station updated an incoming ringing call. The Team Button notification alert status depends on ring type.
Public eventMaliciousCallTraceStatusChanged
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.
Public eventSendAllCallsStatusChanged
Occurs when the status of the send all calls feature has changed.
Public eventSendNNStatusChanged
Occurs when the parameters of the send-nn feature have changed.
Public eventServiceObservingDisabled
An event that is raised when the agent service observing feature is disabled.
Public eventServiceObservingEnabled
An event that is raised when the agent service observing feature is enabled.
Public eventServiceObservingError Obsolete.
An event that reports an error received for service observing session.
Public eventServiceObservingStatusChanged
Occurs when the status of the service observing feature has changed.
The status can also be retrieved using GetServiceObservingStatusParameters method.
Public eventTeamButtonBusyStatusChanged
Occurs if the Team Button busy status is changed when the monitored station either dials or has an active call.
Public eventTeamButtonForwardingStatusChanged
Occurs when the forwarding status of monitored station is changed.
Public eventTeamButtonsChanged
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