us.zoom.sdk.PhoneHelper Interface Reference

Data Structures
enum	CallInNumberType
	Enumeration of the number types for calling to join the audio into a meeting. More...
interface	CallInPhoneNumberInfo
	Call-in phone number info. More...
enum	PhoneFailedReason
	Enumeration of the reasons for the telephone call’s failure. More...
enum	PhoneStatus
	Enumeration of phone call status. More...
interface	PhoneSupportCountryInfo

Public Member Functions
void	addListener (PhoneHelperListener listener)
	add phone helper listener
void	removeListener (PhoneHelperListener listener)
	remove add phone helper listener
boolean	isSupportPhoneFeature ()
	Determine if the user account supports calling out.
boolean	isDialOutSupported ()
	Query if it is able to dial out in the current meeting.
List< PhoneSupportCountryInfo >	getSupportCountryInfo ()
	Get the list of the countries which support calling out.
MobileRTCSDKError	inviteCallOutUser (String countryCode, String phoneNumber, String userName)
	Invite the specified user to join the meeting by calling out.
MobileRTCSDKError	cancelCallOutUser ()
	Cancel the invitation that is being called out by phone.
PhoneStatus	getInviteCallOutUserStatus ()
	Get the invited user's status by calling out.
MobileRTCSDKError	callMe (String countryCode, String phoneNumber)
	Invite myself to join audio to the meeting by phone.
MobileRTCSDKError	hangUp ()
	Cancel the current CALL ME action.
PhoneStatus	getCallMeStatus ()
	Get the status of the invitation by CALL ME.
List< CallInPhoneNumberInfo >	getCurrentMeetingCallInNumber ()
	Get the list of call-in numbers supported by the meeting.
long	getCurrentMeetingCallInParticipantID ()
	Get the ID of the participant who joins the meeting by calling in.

Detailed Description

Definition at line 5 of file PhoneHelper.java.

Member Function Documentation

addListener()

void us.zoom.sdk.PhoneHelper.addListener

(

PhoneHelperListener

listener

)

add phone helper listener

Parameters

listener

PhoneHelperListener

callMe()

MobileRTCSDKError us.zoom.sdk.PhoneHelper.callMe	(	String	countryCode,
		String	phoneNumber )

Invite myself to join audio to the meeting by phone.

Parameters

countryCode	The country code
phoneNumber	The device's phone number.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

cancelCallOutUser()

MobileRTCSDKError us.zoom.sdk.PhoneHelper.cancelCallOutUser

(

)

Cancel the invitation that is being called out by phone.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

getCallMeStatus()

PhoneStatus us.zoom.sdk.PhoneHelper.getCallMeStatus

(

)

Get the status of the invitation by CALL ME.

Returns

If the function succeeds, the return value is the status of the invitation by CALL ME. To get extended error information.

getCurrentMeetingCallInNumber()

List< CallInPhoneNumberInfo > us.zoom.sdk.PhoneHelper.getCurrentMeetingCallInNumber

(

)

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

Returns

If the function succeeds, the return value is the list of the call-in numbers.

getCurrentMeetingCallInParticipantID()

long us.zoom.sdk.PhoneHelper.getCurrentMeetingCallInParticipantID

(

)

Get the ID of the participant who joins the meeting by calling in.

Returns

If the function succeeds, the return value is the participant ID.

getInviteCallOutUserStatus()

PhoneStatus us.zoom.sdk.PhoneHelper.getInviteCallOutUserStatus

(

)

Get the invited user's status by calling out.

Returns

the current call-out status.

getSupportCountryInfo()

List< PhoneSupportCountryInfo > us.zoom.sdk.PhoneHelper.getSupportCountryInfo

(

)

Get the list of the countries which support calling out.

Returns

list of the countries, see PhoneSupportCountryInfo

hangUp()

MobileRTCSDKError us.zoom.sdk.PhoneHelper.hangUp

(

)

Cancel the current CALL ME action.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

inviteCallOutUser()

MobileRTCSDKError us.zoom.sdk.PhoneHelper.inviteCallOutUser	(	String	countryCode,
		String	phoneNumber,
		String	userName )

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

Parameters

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

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

isDialOutSupported()

boolean us.zoom.sdk.PhoneHelper.isDialOutSupported

(

)

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

Returns

true means able. Otherwise returns false.

isSupportPhoneFeature()

boolean us.zoom.sdk.PhoneHelper.isSupportPhoneFeature

(

)

Determine if the user account supports calling out.

Returns

True means that the client supports the phone call out feature. Otherwise, phone call-out is not supported.

removeListener()

void us.zoom.sdk.PhoneHelper.removeListener

(

PhoneHelperListener

listener

)

remove add phone helper listener

Parameters

listener

PhoneHelperListener