Phone call service interface. More...

#include <IPhoneCallService.h>

Public Member Functions
virtual	~IPhoneCallService ()

virtual ZRCSDKError	RegisterSink (IPhoneCallServiceSink *pSink)=0
	Register phone call service callback sink.

virtual ZRCSDKError	DeregisterSink (IPhoneCallServiceSink *pSink)=0
	Deregister phone call service callback sink.

virtual ZRCSDKError	AcceptIncomingSIPCall (const SIPCallInfo &sipCallInfo)=0
	Accept incoming SIP call.

virtual ZRCSDKError	HoldAndAcceptIncomingSIPCall (const SIPCallInfo &sipCallInfo)=0
	Accept incoming SIP call and hold the foreground call.

virtual ZRCSDKError	EndAndAcceptIncomingSIPCall (const SIPCallInfo &sipCallInfo)=0
	Accept incoming SIP call and end the foreground call.

virtual ZRCSDKError	DeclineIncomingSIPCall (const SIPCallInfo &sipCallInfo)=0
	Decline incoming SIP call.

virtual ZRCSDKError	AcceptSIPCallToMeeting (const SIPCallInfo &sipCallInfo)=0
	Accept the invitation to upgrade the SIP call to meeting.

virtual ZRCSDKError	DeclineSIPCallToMeeting (const SIPCallInfo &sipCallInfo)=0
	Decline the invitation to upgrade the SIP call to meeting.

virtual ZRCSDKError	CallSIP (const std::string &uri)=0
	Make a call.

virtual ZRCSDKError	HangupSIPCall (const SIPCallInfo &sipCallInfo)=0
	Hang up an active SIP call.

virtual ZRCSDKError	MuteSIPCallAudio (bool mute)=0
	Mute the SIP call audio.

virtual ZRCSDKError	SendDTMFToSIPCall (const std::string &dtmf, const SIPCallInfo &sipCallInfo)=0
	Send DTMF to the SIP call.

virtual ZRCSDKError	HoldSIPCall (const SIPCallInfo &sipCallInfo)=0
	Hold the SIP call.

virtual ZRCSDKError	UnholdSIPCall (const SIPCallInfo &sipCallInfo)=0
	Unhold the SIP call.

virtual ZRCSDKError	MergeSIPCall (const SIPCallInfo &hostSIPCallInfo, const SIPCallInfo &participantSIPCallInfo)=0
	Merge the participant SIP Call to host SIP call.

virtual ZRCSDKError	TransferSIPCall (const SIPCallInfo &sipCallInfo, const SIPCallTransferInfo &transferInfo)=0
	Transfer the SIP call to other people.

virtual ZRCSDKError	CompleteWarmTransfer (const SIPCallInfo &sipCallInfo)=0
	Complete the warm transfer.

virtual ZRCSDKError	CancelWarmTransfer (const SIPCallInfo &sipCallInfo)=0
	Cancel the warm transfer.

virtual ZRCSDKError	UpgradeSIPCallToMeeting (const SIPCallInfo &sipCallInfo, bool isEndCurrentMeeting)=0
	Upgrade the SIP call to meeting.

virtual ZRCSDKError	SetLocationPermissionEnable (bool enable)=0
	Set location permission enable.

virtual ZRCSDKError	GetLocationPermissionEnable (bool &enable)=0
	Get location permission enable.

virtual ZRCSDKError	GetSIPCallList (std::vector< SIPCallInfo > &sipCalls)=0
	Get the SIP calls.

virtual ZRCSDKError	GetUnholdSIPCall (SIPCallInfo &unholdCall)=0
	Get the unhold call which is ongoing call.

Detailed Description

Phone call service interface.

Definition at line 423 of file IPhoneCallService.h.

Constructor & Destructor Documentation

◆ ~IPhoneCallService()

virtual IPhoneCallService::~IPhoneCallService ( )

inlinevirtual

Definition at line 426 of file IPhoneCallService.h.

426{}

Member Function Documentation

◆ AcceptIncomingSIPCall()

virtual ZRCSDKError IPhoneCallService::AcceptIncomingSIPCall ( const SIPCallInfo & sipCallInfo )

pure virtual

Accept incoming SIP call.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

This interface can be used when there are no other ongoing calls. If there are incoming meeting calls or invitations to upgrade the SIP call to meeting, use the API will auto these.

Parameters

sipCallInfo The SIP call which is accepted.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ AcceptSIPCallToMeeting()

virtual ZRCSDKError IPhoneCallService::AcceptSIPCallToMeeting ( const SIPCallInfo & sipCallInfo )

pure virtual

Accept the invitation to upgrade the SIP call to meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

If there are incoming meeting calls, incoming SIP calls or other invitations to upgrade the SIP call to meeting, use the API will auto these.

Parameters

sipCallInfo The SIP call which is accepted.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ CallSIP()

virtual ZRCSDKError IPhoneCallService::CallSIP ( const std::string & uri )

pure virtual

Make a call.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

uri	The peer uri, it can be the extension number or direct number.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ CancelWarmTransfer()

virtual ZRCSDKError IPhoneCallService::CancelWarmTransfer ( const SIPCallInfo & sipCallInfo )

pure virtual

Cancel the warm transfer.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

sipCallInfo The SIP call which is transferred.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ CompleteWarmTransfer()

virtual ZRCSDKError IPhoneCallService::CompleteWarmTransfer ( const SIPCallInfo & sipCallInfo )

pure virtual

Complete the warm transfer.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

sipCallInfo The SIP call which is transferred.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DeclineIncomingSIPCall()

virtual ZRCSDKError IPhoneCallService::DeclineIncomingSIPCall ( const SIPCallInfo & sipCallInfo )

pure virtual

Decline incoming SIP call.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

sipCallInfo The SIP call which is declined.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DeclineSIPCallToMeeting()

virtual ZRCSDKError IPhoneCallService::DeclineSIPCallToMeeting ( const SIPCallInfo & sipCallInfo )

pure virtual

Decline the invitation to upgrade the SIP call to meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

sipCallInfo The SIP call which is declined.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DeregisterSink()

virtual ZRCSDKError IPhoneCallService::DeregisterSink ( IPhoneCallServiceSink * pSink )

pure virtual

Deregister phone call service callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IPhoneCallServiceSink that receives the phone call service callback.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ EndAndAcceptIncomingSIPCall()

virtual ZRCSDKError IPhoneCallService::EndAndAcceptIncomingSIPCall ( const SIPCallInfo & sipCallInfo )

pure virtual

Accept incoming SIP call and end the foreground call.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

This interface can be used when there is already an ongoing call. If there are incoming meeting calls or invitations to upgrade the SIP call to meeting, use the API will auto these.

Parameters

sipCallInfo The SIP call which is accepted.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetLocationPermissionEnable()

virtual ZRCSDKError IPhoneCallService::GetLocationPermissionEnable ( bool & enable )

pure virtual

Get location permission enable.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] enable TRUE indicates enable location permission.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetSIPCallList()

virtual ZRCSDKError IPhoneCallService::GetSIPCallList ( std::vector< SIPCallInfo > & sipCalls )

pure virtual

Get the SIP calls.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] sipCalls The SIP calls.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetUnholdSIPCall()

virtual ZRCSDKError IPhoneCallService::GetUnholdSIPCall ( SIPCallInfo & unholdCall )

pure virtual

Get the unhold call which is ongoing call.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] unholdCall The unhold call.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ HangupSIPCall()

virtual ZRCSDKError IPhoneCallService::HangupSIPCall ( const SIPCallInfo & sipCallInfo )

pure virtual

Hang up an active SIP call.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

sipCallInfo The SIP call which is hung up, or which the SIP call which is upgraded to meeting.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ HoldAndAcceptIncomingSIPCall()

virtual ZRCSDKError IPhoneCallService::HoldAndAcceptIncomingSIPCall ( const SIPCallInfo & sipCallInfo )

pure virtual

Accept incoming SIP call and hold the foreground call.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

This interface can be used when there is already an ongoing call. If there are incoming meeting calls or invitations to upgrade the SIP call to meeting, use the API will auto these.

Parameters

sipCallInfo The SIP call which is accepted.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ HoldSIPCall()

virtual ZRCSDKError IPhoneCallService::HoldSIPCall ( const SIPCallInfo & sipCallInfo )

pure virtual

Hold the SIP call.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

sipCallInfo The SIP call which is held.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ MergeSIPCall()

virtual ZRCSDKError IPhoneCallService::MergeSIPCall	(	const SIPCallInfo &	hostSIPCallInfo,
		const SIPCallInfo &	participantSIPCallInfo
	)

pure virtual

Merge the participant SIP Call to host SIP call.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

hostSIPCallInfo	The SIP call which the participant SIP call info is merged to.
participantSIPCallInfo	The SIP call which is merged.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ MuteSIPCallAudio()

virtual ZRCSDKError IPhoneCallService::MuteSIPCallAudio ( bool mute )

pure virtual

Mute the SIP call audio.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

mute	TRUE indicates mute SIP call audio. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RegisterSink()

virtual ZRCSDKError IPhoneCallService::RegisterSink ( IPhoneCallServiceSink * pSink )

pure virtual

Register phone call service callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IPhoneCallServiceSink that receives the phone call service callback.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ SendDTMFToSIPCall()

virtual ZRCSDKError IPhoneCallService::SendDTMFToSIPCall	(	const std::string &	dtmf,
		const SIPCallInfo &	sipCallInfo
	)

pure virtual

Send DTMF to the SIP call.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

dtmf	The character which is sent to the SIP call. The characters include 0~9, *, +, #.
sipCallInfo	The SIP call which the dtmf is sent to.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ SetLocationPermissionEnable()

virtual ZRCSDKError IPhoneCallService::SetLocationPermissionEnable ( bool enable )

pure virtual

Set location permission enable.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

enable TRUE indicates the enable location permission. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ TransferSIPCall()

virtual ZRCSDKError IPhoneCallService::TransferSIPCall	(	const SIPCallInfo &	sipCallInfo,
		const SIPCallTransferInfo &	transferInfo
	)

pure virtual

Transfer the SIP call to other people.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

sipCallInfo	The SIP call which is transferred.
transferInfo	The info includes transfer's type and peer URI who the call is transferred to, details SIPCallTransferInfo struct.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ UnholdSIPCall()

virtual ZRCSDKError IPhoneCallService::UnholdSIPCall ( const SIPCallInfo & sipCallInfo )

pure virtual

Unhold the SIP call.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

sipCallInfo The SIP call which is unheld.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ UpgradeSIPCallToMeeting()

virtual ZRCSDKError IPhoneCallService::UpgradeSIPCallToMeeting	(	const SIPCallInfo &	sipCallInfo,
		bool	isEndCurrentMeeting
	)

pure virtual

Upgrade the SIP call to meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

sipCallInfo	The SIP call which is upgraded.
isEndCurrentMeeting	TRUE indicates end current meeting. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IPhoneCallService()

Member Function Documentation

◆ AcceptIncomingSIPCall()

◆ AcceptSIPCallToMeeting()

◆ CallSIP()

◆ CancelWarmTransfer()

◆ CompleteWarmTransfer()

◆ DeclineIncomingSIPCall()

◆ DeclineSIPCallToMeeting()

◆ DeregisterSink()

◆ EndAndAcceptIncomingSIPCall()

◆ GetLocationPermissionEnable()

◆ GetSIPCallList()

◆ GetUnholdSIPCall()

◆ HangupSIPCall()

◆ HoldAndAcceptIncomingSIPCall()

◆ HoldSIPCall()

◆ MergeSIPCall()

◆ MuteSIPCallAudio()

◆ RegisterSink()

◆ SendDTMFToSIPCall()

◆ SetLocationPermissionEnable()

◆ TransferSIPCall()

◆ UnholdSIPCall()

◆ UpgradeSIPCallToMeeting()