InvitePhoneUserInfo Struct Reference

The info for InvitePhoneUser. More...

#include <zoom_video_sdk_phone_helper_interface.h>

Public Member Functions
	InvitePhoneUserInfo ()

Public Attributes
const zchar_t *	countryCode
const zchar_t *	phoneNumber
const zchar_t *	name
bool	bPressOne
bool	bGreeting
const zchar_t *	languageCode
const zchar_t *	variantId

Detailed Description

The info for InvitePhoneUser.

Note

languageCode and variantId must be used together (both provided or both nullptr). Use getPhoneWelcomeMessageInfoList() to retrieve the list of valid language codes and variant IDs. If provided with an invalid value, invitePhoneUser() returns ZoomVideoSDKErrors_Invalid_Parameter.

Definition at line 196 of file zoom_video_sdk_phone_helper_interface.h.

Constructor & Destructor Documentation

InvitePhoneUserInfo()

InvitePhoneUserInfo::InvitePhoneUserInfo ( )

inline

Definition at line 213 of file zoom_video_sdk_phone_helper_interface.h.

    {
        countryCode = nullptr;
        phoneNumber = nullptr;
        name = nullptr;
        bPressOne = true;
        bGreeting = true;
        languageCode = nullptr;
        variantId = nullptr;
    }

References bGreeting, bPressOne, countryCode, languageCode, name, phoneNumber, and variantId.

Member Data Documentation

bGreeting

bool InvitePhoneUserInfo::bGreeting

InvitePhoneUserInfo, true: When joining the session, play a greeting prompt tone., otherwise not.

Definition at line 207 of file zoom_video_sdk_phone_helper_interface.h.

Referenced by InvitePhoneUserInfo().

bPressOne

bool InvitePhoneUserInfo::bPressOne

InvitePhoneUserInfo , true: Need press number one to agree to join the session, otherwise not.

Definition at line 205 of file zoom_video_sdk_phone_helper_interface.h.

Referenced by InvitePhoneUserInfo().

countryCode

const zchar_t* InvitePhoneUserInfo::countryCode

InvitePhoneUserInfo, The country code of the specified user must be in the support list.

Definition at line 199 of file zoom_video_sdk_phone_helper_interface.h.

Referenced by InvitePhoneUserInfo().

languageCode

const zchar_t* InvitePhoneUserInfo::languageCode

Optional: The welcome message's language code, such as "en-US", "zh-CN".

Definition at line 209 of file zoom_video_sdk_phone_helper_interface.h.

Referenced by InvitePhoneUserInfo().

name

const zchar_t* InvitePhoneUserInfo::name

InvitePhoneUserInfo, The screen name of the specified user in the session.

Definition at line 203 of file zoom_video_sdk_phone_helper_interface.h.

Referenced by InvitePhoneUserInfo().

phoneNumber

const zchar_t* InvitePhoneUserInfo::phoneNumber

InvitePhoneUserInfo, The phone number of specified user.

Definition at line 201 of file zoom_video_sdk_phone_helper_interface.h.

Referenced by InvitePhoneUserInfo().

variantId

const zchar_t* InvitePhoneUserInfo::variantId

Optional: The welcome message's variant ID (e.g., "variant_001").

Definition at line 211 of file zoom_video_sdk_phone_helper_interface.h.

Referenced by InvitePhoneUserInfo().