API Methods

All API methods with a return type of BOOL will return TRUE if successful, FALSE otherwise.

Method Name	Signature	Description
`getSDKVersion`	`NSString* getSDKVersion()`	Returns the current SDK version.
`SIP_GetCodecList`	`NSArray* SIP_GetCodecList()`	Retrieves the list of supported codecs.
`SIP_GetAvailableAudioDevices`	`NSArray* SIP_GetAvailableAudioDevices()`	Returns the available audio devices on the machine.
`SIP_MakeCallToNumber`	`int SIP_MakeCallToNumber(NSString* number)`	Makes a call to the specified phone number.
`SIP_GetSelectedAudioDevicesCapture`	`BOOL SIP_GetSelectedAudioDevicesCapture(int* captureDev, int* playbackDev)`	Gets the currently selected audio devices for making calls.
`SIP_SetCallAudioDeviceWithCaptureDev`	`BOOL SIP_SetCallAudioDeviceWithCaptureDev(int captureDev, int playbackDev)`	Sets the index of the audio devices used for recording and playback.
`SIP_HandleIPChange`	`void SIP_HandleIPChange()`	Handles network changes to avoid call interruptions.
`SIP_DisconnectCallWithId`	`BOOL SIP_DisconnectCallWithId(int call_id, int code)`	Disconnects an existing SIP call with a given code.
`SIP_DisconnectAllCallsWithCode`	`BOOL SIP_DisconnectAllCallsWithCode(int code)`	Disconnects all active calls with a given code.
`SIP_MuteMicForCallId`	`BOOL SIP_MuteMicForCallId(int call_id, BOOL isMuted)`	Mutes or unmutes the microphone stream of a given call.
`SIP_SetAllMicMuted`	`BOOL SIP_SetAllMicMuted(BOOL isMuted)`	Mutes or unmutes the microphone for all active calls.
`SIP_SendDTMFForCallId`	`BOOL SIP_SendDTMFForCallId(int call_id, NSString* dtmfDigits)`	Sends a string of DTMF digits via RFC2833 over an existing call.
`SIP_HoldCallWithId`	`BOOL SIP_HoldCallWithId(int call_id)`	Puts an existing call on hold.
`SIP_HoldAllCalls`	`BOOL SIP_HoldAllCalls()`	Puts all active calls on hold.
`SIP_UnholdCallWithId`	`BOOL SIP_UnholdCallWithId(int call_id)`	Resumes a previously held call.
`SIP_UnholdAllCalls`	`BOOL SIP_UnholdAllCalls()`	Resumes all previously held calls.
`SIP_ChangeTxVolumeForCallId`	`BOOL SIP_ChangeTxVolumeForCallId(int call_id, float level)`	Changes the transmit volume of a call.
`SIP_ChangeRxVolumeForCallId`	`BOOL SIP_ChangeRxVolumeForCallId(int call_id, float level)`	Changes the receive volume of a call.
`SIP_AttendedTransferForCallId`	`BOOL SIP_AttendedTransferForCallId(int call_id, NSString* destinationNumber)`	Performs an attended transfer to another number.
`SIP_CancelTransferForCallId`	`BOOL SIP_CancelTransferForCallId(int call_id)`	Cancels a previous attended transfer request.
`SIP_GetActiveCallIDs`	`NSArray* SIP_GetActiveCallIDs()`	Retrieves the list of IDs for ongoing calls.
`SIP_AnswerCallWithId`	`BOOL SIP_AnswerCallWithId(int call_id)`	Answers an incoming call.
`SIP_AnswerCallWaiting`	`NSDictionary* SIP_AnswerCallWaiting()`	Answers an incoming call while holding the active call.
`SIP_SwapCallWaitingForCallId`	`NSDictionary* SIP_SwapCallWaitingForCallId(int active_call_id)`	Swaps between an active call and a held call.
`SIP_StartConference`	`NSDictionary* SIP_StartConference()`	Bridges two connected calls into a conference.
`SIP_TransmitWhiteNoise`	`int SIP_TransmitWhiteNoise()`	Transmits a short burst of white noise to reset the idle timer.
`SIP_RegisterThread`	`BOOL SIP_RegisterThread()`	Registers the current thread with the SIP stack.
`SIP_ToggleRegistrationForAccount`	`BOOL SIP_ToggleRegistrationForAccount(int acc_id, BOOL enabled)`	Enables or disables SIP registration for an account.
`SIP_GetLegUuid`	`NSString* SIP_GetLegUuid(int call_id)`	Retrieves the history leg UUID of a specified call.
`SIP_GetCallStats`	`NSString* SIP_GetCallStats(int call_id)`	Retrieves call statistics as a string for diagnostics.
`SIP_GetCallStatDict`	`NSDictionary* SIP_GetCallStatDict(int call_id)`	Retrieves call statistics as a JSON object.
`processPushMsg (iOS only)`	`NSDictionary* processPushMsg(NSDictionary* userInfo)`	Parses an incoming push message to determine call events.
`CallStateCallBack`	`typedef void(^CallStateCallBack)(int call_id, NSString* inv_state, int last_status, NSString* last_status_text)`	Callback for call state changes.
`RegStateCallBack`	`typedef void(^RegStateCallBack)(int acc_id, NSString* acc_uri, int status, NSString* status_text)`	Callback for registration state changes.
`IncomingCallStateCallBack`	`typedef void(^IncomingCallStateCallBack)(int acc_id, int call_id, NSString* remote_uri, NSString* local_uri, NSString* remote_name, NSString* remote_number, NSString* local_name, NSString* local_number)`	Callback for new incoming calls.