The MakeCallUri procedure is called by application software to initiate an outbound phone call using a SIP URI. It is similar in functionality to the MakeCall(String, String, UInt32, Int32, Boolean, UInt32) API procedure.

Namespace:  LanScape
Assembly:  LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE MakeCallUri(
	string SipUri,
	bool UseProxy,
	int PhoneLine,
	bool Synchronous,
	uint TimeOutMs
)
Visual Basic (Declaration)
Public Function MakeCallUri ( _
	SipUri As String, _
	UseProxy As Boolean, _
	PhoneLine As Integer, _
	Synchronous As Boolean, _
	TimeOutMs As UInteger _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE MakeCallUri(
	String^ SipUri, 
	bool UseProxy, 
	int PhoneLine, 
	bool Synchronous, 
	unsigned int TimeOutMs
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE MakeCallUri(
	String SipUri,
	boolean UseProxy,
	int PhoneLine,
	boolean Synchronous,
	UInt32 TimeOutMs
)

Parameters

SipUri
Type: System..::.String
The NULL terminated string containing the SIP URI. This is the destination to call. The basic form of an acceptable SIP URI is sip:user@host:port. At this time the media engine only processes user, host and port of SIP URIs. For a complete description of SIP URIs, please see section 19.1.1 (SIP and SIPS URI Components) of the SIP RFC (RFC3261).
UseProxy
Type: System..::.Boolean
If specified as non zero, then the call will be sent through your configured proxy server regardless of the destination address specified in the pSipUri parameter. The proxy will then be responsible for forwarding the call to the proper destination.
PhoneLine
Type: System..::.Int32
The zero based phone line to access.
Synchronous
Type: System..::.Boolean
If this parameter is non zero (TRUE), the procedure will not return until: the call is terminated or an error has been detected. If this parameter is zero (FALSE), then this procedure will return immediately with the return value of SipSuccess. The call's termination progress and state changes should be monitored by application software using the event notification callback mechanism.
TimeOutMs
Type: System..::.UInt32
If the phone call is being made synchronously, then this parameter specifies the maximum timeout in milliseconds the procedure will wait for the call to go active (answered by the far end).

Return Value

If the function succeeds, the return value will be SipSuccess.

If the function fails, the return value will be one of the following values as specified by the VoipMediaEngine..::.TELEPHONY_RETURN_VALUE data type. The MakeCallUri API procedure returns the same values as specified by the MakeCall(String, String, UInt32, Int32, Boolean, UInt32) API procedure in addition to the following return values:

Return ValueDescription
SipProxyNotEnabled
Indicates that an operation was attempted that requires a proxy server to be configured and enabled. However, proxy support has not yet been enabled.

(API return value)

SipBadSipUri
A bad Sip URI string was passed to the MakeCallUri(String, Boolean, Int32, Boolean, UInt32) API procedure.

(API return value)

Remarks

None.

See Also