Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKPhoneHelper.h
Go to the documentation of this file.
1
5
6#import <Foundation/Foundation.h>
7
16@property (nonatomic, copy) NSString * _Nullable countryID;
20@property (nonatomic, copy) NSString * _Nullable countryName;
24@property (nonatomic, copy) NSString * _Nullable countryCode;
25@end
26
27
32@interface ZoomVideoSDKDialInNumberInfo : NSObject
36@property (nonatomic, copy) NSString * _Nullable countryID;
40@property (nonatomic, copy) NSString * _Nullable countryCode;
44@property (nonatomic, copy) NSString * _Nullable countryName;
48@property (nonatomic, copy) NSString * _Nullable number;
52@property (nonatomic, copy) NSString * _Nullable displayNumber;
56@property (nonatomic, assign) ZoomVideoSDKDialInNumType type;
57
61@property (nonatomic, assign) BOOL isDedicateID;
62@end
63
64
76@property (nonatomic, copy) NSString * _Nullable countryCode;
77
81@property (nonatomic, copy) NSString * _Nullable phoneNumber;
82
86@property (nonatomic, copy) NSString * _Nullable name;
87
91@property (nonatomic, assign) BOOL bPressOne;
92
96@property (nonatomic, assign) BOOL bGreeting;
97
101@property (nonatomic, copy) NSString * _Nullable languageCode;
102
106@property (nonatomic, copy) NSString * _Nullable variantId;
107@end
108
117@property (nonatomic, copy) NSString * _Nullable languageCode;
121@property (nonatomic, copy) NSString * _Nullable languageName;
125@property (nonatomic, copy) NSString * _Nullable variantId;
126@end
127
132@interface ZoomVideoSDKPhoneHelper : NSObject
133
139
145
154- (ZoomVideoSDKError)inviteByPhone:(NSString *_Nonnull)countryCode phoneNumber:(NSString *_Nonnull)phoneNumber name:(NSString *_Nonnull)name
155DEPRECATED_MSG_ATTRIBUTE("use invitePhoneUser: instead");
156
162- (ZoomVideoSDKError)invitePhoneUser:(ZoomVideoSDKInvitePhoneUserInfo * _Nullable)inviteInfo;
163
169
175
181
189
190@end
ZoomVideoSDKError
Enumeration of all the errors in the VideoSDK.
ZoomVideoSDKPhoneStatus
Enumeration of phone call statuses.
ZoomVideoSDKDialInNumType
Enumeration of the number types for calling to join the audio into a meeting.
Dial in number information interface.
NSString *_Nullable countryID
The country ID.
BOOL isDedicateID
Determines whether the dial number is an account dedicated number.
ZoomVideoSDKDialInNumType type
Dial in number type.
NSString *_Nullable displayNumber
Dial in number format string for display.
NSString *_Nullable countryCode
The country code.
NSString *_Nullable countryName
The country name.
NSString *_Nullable number
Dial in number.
Information for inviting phone users.
NSString *_Nullable languageCode
Optional: The welcome message's language code, such as "en-US", "zh-CN".
BOOL bGreeting
Determines whether to play a greeting prompt tone when joining the session.
NSString *_Nullable countryCode
The country code of the specified user must be in the support list.
BOOL bPressOne
Determines whether the user needs to press number one to agree to join the session.
NSString *_Nullable phoneNumber
The phone number of specified user.
NSString *_Nullable name
The screen name of the specified user in the session.
NSString *_Nullable variantId
Optional: The welcome message's variant ID (e.g., "variant_001").
Provides methods for managing phone-related session features such as dial-in and phone invites.
NSArray< ZoomVideoSDKDialInNumberInfo * > *_Nullable getSessionDialInNumbers()
Gets the video SDK dial in number information list.
ZoomVideoSDKPhoneStatus getInviteByPhoneStatus()
Gets the status of the invitation by phone.
BOOL isSupportPhoneFeature()
Determines whether the session supports join by phone.
NSArray< ZoomVideoSDKPhoneWelcomeMessageInfo * > *_Nullable getPhoneWelcomeMessageInfoList()
Gets the list of multilingual welcome message information.
NSArray< ZoomVideoSDKPhoneSupportCountryInfo * > *_Nullable getSupportCountryInfo()
Gets the list of country information where the session supports join by telephone.
ZoomVideoSDKError cancelInviteByPhone()
Cancels the invitation that is being called out by phone.
Support country information interface.
NSString *_Nullable countryCode
The country code.
NSString *_Nullable countryName
The country name.
NSString *_Nullable countryID
The country ID.
Welcome message information for phone invitation.
NSString *_Nullable variantId
The current information's variant ID.
NSString *_Nullable languageCode
The current information's language code, such as "en-US", "zh-CN".
NSString *_Nullable languageName
The current information's language name, such as "English (US)", "Chinese (China)".