SipTelephonyEnable

 

The SipTelephonyEnable function is used after an instance of the telephony engine is created and after all configuration API procedures have been executed. Calling SipTelephonyEnable allows the telephony engine to accept incoming SIP traffic. It also allows you to make out bound calls. You must call this API procedure in order to initiate or receive voice over IP phone calls.

Note 1:
If you require domain, proxy or registrar support, you must call this API procedure prior to using domain, proxy or registrar APIs. For further information, see "How to enable Domain, Proxy and Registrar support".

 

Note 2: If you want to subscribe to events offered by another telephony device, you must call the StartEventSubscription API procedure after calling this SIpTelephonyEnable API.

 

TELEPHONY_RETURN_VALUE SipTelephonyEnable(

SIPHANDLE hStateMachine

);

 

 

 

Parameters:

 

hStateMachine

[in] The handle to the telephony engine. This is the handle that was returned by a previous call to the StartSipTelephony procedure.

 

 

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.

 

SipCallFailure

This is a generic "catch all" API error. If an error condition is not specified by any other API error value, this error will be returned.