GetDeviceId Method (extension, switchName, switchIpInterface, controllableByOtherSessions, userState)

Send a GetDeviceId XML message to the server.

Declaration Syntax

Visual Basic

Visual C++

int GetDeviceId(
	string extension,
	string switchName,
	string switchIpInterface,
	bool controllableByOtherSessions,
	Object userState
)

Function GetDeviceId ( _
	extension As String, _
	switchName As String, _
	switchIpInterface As String, _
	controllableByOtherSessions As Boolean, _
	userState As Object _
) As Integer

int GetDeviceId(
	String^ extension, 
	String^ switchName, 
	String^ switchIpInterface, 
	bool controllableByOtherSessions, 
	Object^ userState
)

Parameters

extension (String): Extension number administered for the desired device. Must be a DCP or IP extension that is administered as softphone-enabled. This parameter is mandatory.

switchName (String): Specifies the name of a switch administered through the administration web pages. At least one of the switchName and/or switchIPInterface parameters must be set.

switchIpInterface (String): Specifies the IP address (or DNS name) of a CLAN gatekeeper on the switch where the extension is administered. At least one of the switchName and/or switchIPInterface parameters must be set.

controllableByOtherSessions (Boolean): Specifies whether multiple sessions can control the device. This was added for backward compatibility with 3.x and 4.0 releases. The default behavior when this is not specified is to allow only a single session to control the device.

userState (Object): Any object the application would like returned with the response.

Return Value

The Invoke ID of the XML message sent to the server.

Assembly: ServiceProvider (Module: ServiceProvider)