JTapiGetDeviceStatus

JTapiGetDeviceStatus
Prev	Actions	Next

JTapiGetDeviceStatus

Metreos.Providers.JTapi.JTapiGetDeviceStatus

Provider
Synchronous
No Custom Parameters

Summary: Gets the device status of a phone using JTAPI.
Usage: JTapiGetDeviceStatus gets the device status of a monitored phone using JTAPI.
Remarks: None.

Action Parameters
Parameter Name	.NET Type	Default	Description
Timeout	`System.Int32`		The `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.String`		The name of a controlled device to query.

Result Data
Parameter Name	.NET Type	Description
DeviceStatus	`System.String`	The current status of the queried device. Possible values are: Idle The phone is not in a call. It could be either on hook or off hook. Active The phone is in a call, and is actively talking (not on hold). Alerting The phone is ringing. Held The phone is in a call, and is not actively talking (is on hold). Unknown Undefined.
ResultCode	`System.String`	Describes the result of the action with a textual success or error message.

Branch Conditions

Success: No description.
Failure: No description.
Timeout: No description.

Prev	Up	Next
JTapiUnsubscribe	Home	Events