JTapiGetCallForwardStatus
Prev Actions Next

JTapiGetCallForwardStatus

Metreos.Providers.JTapi.JTapiGetCallForwardStatus

Summary

Gets the call forward status of a line on a monitored device.

Usage

JTapiGetCallForwardStatus gets the call forward status of a line on a monitored phone. If the action is successful, the CallForwardType result data parameter should be used to determine the status of the call forwarding status. If the CallForwardType indicates that the line has the forward condition Unconditional, then the Digits parameter can be used to determine which destination the line is currently forwarded to.

Remarks
While a line in Cisco Unified Communications Manager can have multiple Call Forwarding conditions, such as 'Busy' and 'No Answer', the JTapiGetCallForwardStatus action can only determine if a line is forwarded 'unconditionally', or in other words, if the line in Cisco Unified Communications Manager has set 'Call Forward All' to a particular destination.
Action Parameters
Parameter Name.NET TypeDefaultDescription
DirectoryNumberSystem.StringThe line number on the device whose call forward status needs to be determined.
DeviceName *System.StringThe name of a controlled device from whose call forward status is queried. The DirectoryNumber action parameter must be a valid line number on this device.
TimeoutSystem.Int32The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action. The ReturnValue returned in this case is Timeout. The value must be a literal value in milliseconds.
Result Data
Parameter Name.NET TypeDescription
CallForwardTypeSystem.StringCallForwardType indicates the current forwarding status of the phone:
No Call Forward Set

The specified line is not set to 'Call Forward All' in the Cisco Unified Communications Manager. Note that the line in question could have 'Call Forward Busy', 'No Answer', or other call forward conditions set in the actual Cisco Unified Communications Manager configuration of this line, and still return this condition for CallForwardType. In other words, since this action only supports querying the 'Call Forward All' status, No Call Forward Set refers to that status of that condition specifically.

Unconditional

The specified line is set to 'Call Forward All' in the Cisco Unified Communications Manager. Refer to the Digits result data parameter in order to determine the actual destination of the forward, if applicable.

""

Unknown.

DigitsSystem.StringThe destination to which the call forward is set. This value is only valid if CallForwardType is set to Unconditional.

Branch Conditions 

Success

No description.

Failure

No description.

Timeout

No description.

Prev Up Next
JTapiBlindTransfer Home JTapiStartMonitoring