JTapiGetActiveCalls

Metreos.Providers.JTapi.JTapiGetActiveCalls

Summary

Gets the CallIDs active on the device.

Usage

JTapiGetActiveCalls gets the active calls on a particular line on a monitored phone. If the action is successful, the CallIDs result data parameter will contain the call ids (String Array of call ids) active on the device or lineDN (address). These CallIDs can be used for other JTAPI operations like JTapiHold,JTapiStartMonitoring etc.

Note: Both the LineDN and DeviceName need to be passed as arguments.

Action Parameters
Parameter Name.NET TypeDefaultDescription
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.
DeviceName *System.StringThe name of the device on which active calls are being queried.
LineDN *System.StringThe directory number (address) on which active calls are being queried.
Result Data
Parameter Name.NET TypeDescription
CallIDsSystem.String[]CallIDs indicates the active calls on the monitored device.

Branch Conditions 

Success

No description.

Failure

No description.

Timeout

No description.