Provides methods for managing phone-related session features such as dial-in and phone invites. More...

#include <ZoomVideoSDKPhoneHelper.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isSupportPhoneFeature
	Determines whether the session supports join by phone.
(NSArray< ZoomVideoSDKPhoneSupportCountryInfo * > *_Nullable)	- getSupportCountryInfo
	Gets the list of country information where the session supports join by telephone.
(ZoomVideoSDKError)	- inviteByPhone:phoneNumber:name:
	Invites the specified user to join the session by call out.
(ZoomVideoSDKError)	- invitePhoneUser:
	Invites the specified user to join the session by call out.
(ZoomVideoSDKError)	- cancelInviteByPhone
	Cancels the invitation that is being called out by phone.
(ZoomVideoSDKPhoneStatus)	- getInviteByPhoneStatus
	Gets the status of the invitation by phone.
(NSArray< ZoomVideoSDKDialInNumberInfo * > *_Nullable)	- getSessionDialInNumbers
	Gets the video SDK dial in number information list.
(NSArray< ZoomVideoSDKPhoneWelcomeMessageInfo * > *_Nullable)	- getPhoneWelcomeMessageInfoList
	Gets the list of multilingual welcome message information.

Detailed Description

Provides methods for managing phone-related session features such as dial-in and phone invites.

Definition at line 132 of file ZoomVideoSDKPhoneHelper.h.

Method Documentation

◆ cancelInviteByPhone

- (ZoomVideoSDKError) cancelInviteByPhone

Cancels the invitation that is being called out by phone.

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

References cancelInviteByPhone.

Referenced by cancelInviteByPhone.

◆ getInviteByPhoneStatus

- (ZoomVideoSDKPhoneStatus) getInviteByPhoneStatus

Gets the status of the invitation by phone.

Returns: If the function succeeds, the method returns the ZoomVideoSDKPhoneStatus of the invitation by phone.

References getInviteByPhoneStatus.

Referenced by getInviteByPhoneStatus.

◆ getPhoneWelcomeMessageInfoList

- (NSArray< ZoomVideoSDKPhoneWelcomeMessageInfo * > *_Nullable) getPhoneWelcomeMessageInfoList

Gets the list of multilingual welcome message information.

Returns: If the function succeeds, it returns an NSArray of welcome message information objects. Returns an empty list if no languages are configured. Otherwise, this function fails and returns nil.

Note: Use this method to query valid language codes and variant IDs before passing them to invitePhoneUser: via ZoomVideoSDKInvitePhoneUserInfo. The welcome messages must be pre-uploaded to the Zoom web portal. Each language may have multiple variants with user-defined identifiers.

References getPhoneWelcomeMessageInfoList.

Referenced by getPhoneWelcomeMessageInfoList.

◆ getSessionDialInNumbers

- (NSArray< ZoomVideoSDKDialInNumberInfo * > *_Nullable) getSessionDialInNumbers

Gets the video SDK dial in number information list.

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

References getSessionDialInNumbers.

Referenced by getSessionDialInNumbers.

◆ getSupportCountryInfo

- (NSArray< ZoomVideoSDKPhoneSupportCountryInfo * > *_Nullable) getSupportCountryInfo

Gets the list of country information where the session supports join by telephone.

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

References getSupportCountryInfo.

Referenced by getSupportCountryInfo.

◆ inviteByPhone:phoneNumber:name:

- (ZoomVideoSDKError) inviteByPhone:	(NSString *_Nonnull)	countryCode
phoneNumber:	(NSString *_Nonnull)	phoneNumber
name:	(NSString *_Nonnull)	name

Invites the specified user to join the session by call out.

Parameters

countryCode	The country code of the specified user. Must be in the support list.
phoneNumber	The phone number of the specified user.
name	The screen name of the specified user in the session.

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

Deprecated: Use invitePhoneUser: instead.

◆ invitePhoneUser:

- (ZoomVideoSDKError) invitePhoneUser: (ZoomVideoSDKInvitePhoneUserInfo *_Nullable) inviteInfo

Invites the specified user to join the session by call out.

Parameters

inviteInfo The invite action information.

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

◆ isSupportPhoneFeature

- (BOOL) isSupportPhoneFeature

Determines whether the session supports join by phone.

Returns: YES if the session supports join by phone. Otherwise, NO.

References isSupportPhoneFeature.

Referenced by isSupportPhoneFeature.

Instance Methods