The AbortIncomingCall procedure is called by application software to abort (Ignore) a received incoming phone call. When this API procedure is called, the media engine will send a SIP status response back to the other user agent or configured SIP proxy.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE AbortIncomingCall(
	int PhoneLine,
	int AbortSipStatusCode,
	string AbortSipReasonPhrase
)
Visual Basic (Declaration)
Public Function AbortIncomingCall ( _
	PhoneLine As Integer, _
	AbortSipStatusCode As Integer, _
	AbortSipReasonPhrase As String _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE AbortIncomingCall(
	int PhoneLine, 
	int AbortSipStatusCode, 
	String^ AbortSipReasonPhrase
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE AbortIncomingCall(
	int PhoneLine,
	int AbortSipStatusCode,
	String AbortSipReasonPhrase
)

Parameters

PhoneLine
Type: System..::.Int32
The zero based phone line to access.
AbortSipStatusCode
Type: System..::.Int32
Specifies the SIP error response code that should be sent to the far end device that initiated the call. Generally this value should be in the range of 400 to 699. See the latest SIP RFC for status code descriptions. Normally your application will want to send the "480 Temporarily Unavailable" response back to the far end of the call. In this case, your application should set the AbortSipStatusCode parameter to a value of 480 and the AbortSipReasonPhrase parameter to the "Temporarily Unavailable" reason phrase string.
AbortSipReasonPhrase
Type: System..::.String
The user defined "man readable" reason phrase that will be included in the response that is sent to the far end device. This can be any ASCII string you require but is generally set to a reason phrase as specified by the SIP RFC.

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.

Return ValueDescription
SipCallFailure
This value is returned by telephony API procedures to indicate general API failure. This error value is used as a "catch all error". If you receive this error, check to make sure that all parameters specified in the API procedure call are correct. Particularly, verify that pointers to memory regions are valid. This error return value is only used if a mapping to another specific error value does not exist.

(API return value)

SipInvalidHandle
Application software specified an invalid telephony handle in one of the API procedures. This usually indicates memory corruption on the part of application software.

(API return value)

SipBadPhoneLine
Application software called a telephony API procedure and specified an invalid phone line. Phone lines are numbered starting from zero. This error is most commonly returned when attempting to access phone lines in excess of the max number of lines supported by the telephony engine.

(API return value)

Remarks

This API procedure should only be called when your application receives the SipOkToAnswerCall event from the Media Engine.

See Also