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

#include <ZMVideoSDKPhoneHelper.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isSupportPhoneFeature
	Determines if the session supports join by phone or not.
(NSArray< ZMVideoSDKPhoneSupportCountryInfo * > *_Nullable)	- getSupportCountryInfo
	Gets the country information list where the session supports to join by telephone.
(ZMVideoSDKErrors)	- inviteByPhone:phoneNumber:name:
	Invite the specified user to join the session by phone.
(ZMVideoSDKErrors)	- invitePhoneUser:
	Invite the specified user to join the session by phone.
(ZMVideoSDKErrors)	- cancelInviteByPhone
	Cancels the invitation that is being called out by phone.
(ZMPhoneStatus)	- getInviteByPhoneStatus
	Gets the phone invitation's status.
(NSArray< ZMVideoSDKDialInNumberInfo * > *_Nullable)	- getSessionDialInNumbers
	Gets the dial in number list supported by session.
(NSArray< ZMVideoSDKPhoneWelcomeMessageInfo * > *_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 129 of file ZMVideoSDKPhoneHelper.h.

Method Documentation

◆ cancelInviteByPhone

- (ZMVideoSDKErrors) cancelInviteByPhone

Cancels the invitation that is being called out by phone.

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

References cancelInviteByPhone.

Referenced by cancelInviteByPhone.

◆ getInviteByPhoneStatus

- (ZMPhoneStatus) getInviteByPhoneStatus

Gets the phone invitation's status.

Returns: The phone invitation's ZMPhoneStatus.

References getInviteByPhoneStatus.

Referenced by getInviteByPhoneStatus.

◆ getPhoneWelcomeMessageInfoList

- (NSArray< ZMVideoSDKPhoneWelcomeMessageInfo * > *_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 ZMVideoSDKInvitePhoneUserInfo. 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< ZMVideoSDKDialInNumberInfo * > *_Nullable) getSessionDialInNumbers

Gets the dial in number list supported by session.

Returns: If the function succeeds, it returns the call-in number list. Otherwise, this function fails and returns nil.

References getSessionDialInNumbers.

Referenced by getSessionDialInNumbers.

◆ getSupportCountryInfo

- (NSArray< ZMVideoSDKPhoneSupportCountryInfo * > *_Nullable) getSupportCountryInfo

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

Returns: If the function succeeds, it returns the country information array. Otherwise, this function fails and returns nil.

References getSupportCountryInfo.

Referenced by getSupportCountryInfo.

◆ inviteByPhone:phoneNumber:name:

- (ZMVideoSDKErrors) inviteByPhone:	(NSString *)	countryCode
phoneNumber:	(NSString *)	phoneNumber
name:	(NSString *)	name

Invite the specified user to join the session by phone.

Parameters

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

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

Deprecated: Use ZMVideoSDKPhoneHelper::invitePhoneUser: instead.

◆ invitePhoneUser:

- (ZMVideoSDKErrors) invitePhoneUser: (ZMVideoSDKInvitePhoneUserInfo *) inviteInfo

Invite the specified user to join the session by phone.

Parameters

inviteInfo The info for invite by phone.

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

◆ isSupportPhoneFeature

- (BOOL) isSupportPhoneFeature

Determines if the session supports join by phone or not.

Returns: YES if join by phone is supported. Otherwise, NO.

References isSupportPhoneFeature.

Referenced by isSupportPhoneFeature.

Instance Methods