LanScape VOIP Media Engine
SetReceivedUnsolicitedNotifyState
The SetReceivedUnsolicitedNotifyState API procedure can be called by application software to allow the media engine to receive and process unsolicited received NOTIFY messages. Unsolicited received NOTIFY messages are not associated with an event subscription. Unsolicited NOTIFY messages are sent to the media engine by far end SIP devices as determined by the far end SIP device. If you interface with another SIP device or server that will send your VOIP application NOTIFY SIP messages without you having to SUBSCRIBE to the NOTIFY events, then you will want to call this API procedure to enable unsolicited NOTIFY processing. For further information, see the SipEventNotifyReceived event.
TELEPHONY_RETURN_VALUE SetReceivedUnsolicitedNotifyState(
SIPHANDLE hStateMachine,
BOOL EnableState
);
Parameters:
hStateMachine
[in] The handle to the telephony engine. This is the handle that was returned by a previous call to the StartSipTelephony procedure.
EnableState
[in] The enable state of unsolicited NOTIFY processing.
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 TELEPHONY_RETURN_VALUE data type.
Value |
Description |
SipInvalidHandle |
An API procedure was passed an invalid handle. The telephony engine attempts to verify user specified telephony handles and returns this error when an invalid handle is detected.
|