SetChallengeAuthenticationState

If your application is required to challenged requests coming from other applications or devices, this API procedure gives you the ability to enable or disable the media engine mechanism associated with inbound request authentication.

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] If set to a nonzero value, your application will be sent the SipIncomingAuthentication event whenever SIP protocol messages of the following type are received: REGISTER, INVITE, BYE, SUBSCRIBE, and NOTIFY. Your application will also have access to data associated with the incoming protocol request as specified by the data in the CHALLENGE_AUTHENTICATION structure. Your application can then inspect the data structure to determine if it wants to allow the media engine to challenge the incoming request. To disable incoming challenge related events, set this parameter to zero.

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.