Provides APIs to manage Zoom phone call-in and call-out features. More...

#include <ZoomSDKPhoneHelper.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isSupportPhone
	Query if current meeting support telephony.
(BOOL)	- isDialoutSupported
	Query if it is able to dial out in the current meeting.
(NSArray *)	- getSupportCountryInfo
	Gets the countries's list which support calling out.
(ZoomSDKError)	- inviteCalloutUser:PhoneNumber:CountryCode:
	Invite the specified user to join the meeting by calling out.
(ZoomSDKError)	- cancelCalloutUser
	Cancels the invitation that is being called out by phone.
(PhoneStatus)	- getInviteCalloutUserStatus
	Gets the invited user's status by calling out.
(ZoomSDKError)	- callMe:CountryCode:
	Invite myself to join audio to the meeting by phone.
(ZoomSDKError)	- hangUp
	Cancels the current CALL ME action.
(PhoneStatus)	- getCallMeStatus
	Gets the status of myself by CALL ME.
(unsigned int)	- getCallInParticipantID
	Gets the participant's ID who joins the meeting by calling in.
(NSArray *_Nullable)	- getCallInNumberInfo
	Gets the list of call-in numbers supported by the meeting.

Protected Attributes
id< ZoomSDKPhoneHelperDelegate >	_delegate
PhoneStatus	_callMeStatus

Properties
id< ZoomSDKPhoneHelperDelegate >	delegate
	Sets the delegate to receive phone call status updates.

Detailed Description

Provides APIs to manage Zoom phone call-in and call-out features.

Definition at line 95 of file ZoomSDKPhoneHelper.h.

Method Documentation

◆ callMe:CountryCode:

- (ZoomSDKError) callMe:		(NSString *)	number
CountryCode:		(NSString *)	countryCode

Invite myself to join audio to the meeting by phone.

Parameters

number	The device’s phone number.
countryCode	The country code.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ cancelCalloutUser

- (ZoomSDKError) cancelCalloutUser

Cancels the invitation that is being called out by phone.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

References cancelCalloutUser.

Referenced by cancelCalloutUser.

◆ getCallInNumberInfo

- (NSArray *_Nullable) getCallInNumberInfo

Gets the list of call-in numbers supported by the meeting.

Returns: If the function succeeds, it returns an array of ZoomSDKCallInPhoneNumInfo objects. Otherwise, this function fails and returns nil.

References getCallInNumberInfo.

Referenced by getCallInNumberInfo.

◆ getCallInParticipantID

- (unsigned int) getCallInParticipantID

Gets the participant's ID who joins the meeting by calling in.

Returns: If the function succeeds, it returns the ID of participant. Otherwise, returns 0.

References getCallInParticipantID.

Referenced by getCallInParticipantID.

◆ getCallMeStatus

- (PhoneStatus) getCallMeStatus

Gets the status of myself by CALL ME.

Returns: The invitation's process by CALL ME.

References getCallMeStatus.

Referenced by getCallMeStatus.

◆ getInviteCalloutUserStatus

- (PhoneStatus) getInviteCalloutUserStatus

Gets the invited user's status by calling out.

Returns: The current callout process.

References getInviteCalloutUserStatus.

Referenced by getInviteCalloutUserStatus.

◆ getSupportCountryInfo

- (NSArray *) getSupportCountryInfo

Gets the countries's list which support calling out.

Returns: An NSArray contains ZoomSDKPhoneSupportCountryInfoList objects of all countries supporting to call out. Otherwise, this function fails and returns nil.

References getSupportCountryInfo.

Referenced by getSupportCountryInfo.

◆ hangUp

- (ZoomSDKError) hangUp

Cancels the current CALL ME action.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

References hangUp.

Referenced by hangUp.

◆ inviteCalloutUser:PhoneNumber:CountryCode:

- (ZoomSDKError) inviteCalloutUser:	(NSString *)	userName
PhoneNumber:	(NSString *)	number
CountryCode:	(NSString *)	countryCode

Invite the specified user to join the meeting by calling out.

Parameters

userName	The specified user’s in-meeting screen name.
number	The specified user’s phone number.
countryCode	The specified user’s country code must be in the support list.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ isDialoutSupported

- (BOOL) isDialoutSupported

Query if it is able to dial out in the current meeting.

Returns: YES if able. Otherwise, NO.

References isDialoutSupported.

Referenced by isDialoutSupported.

◆ isSupportPhone

- (BOOL) isSupportPhone

Query if current meeting support telephony.

Returns: YES if support. Otherwise, NO.

References isSupportPhone.

Referenced by isSupportPhone.

Field Documentation

◆ _callMeStatus

- (PhoneStatus) _callMeStatus

protected

Definition at line 98 of file ZoomSDKPhoneHelper.h.

◆ _delegate

- (id<ZoomSDKPhoneHelperDelegate>) _delegate

protected

Definition at line 97 of file ZoomSDKPhoneHelper.h.

Property Documentation

◆ delegate

- (id<ZoomSDKPhoneHelperDelegate>) delegate

readwritenonatomicassign

Sets the delegate to receive phone call status updates.

Definition at line 103 of file ZoomSDKPhoneHelper.h.

Instance Methods

Protected Attributes

Properties