zoom_video_sdk_phone_helper_interface.h File Reference

phone helper interface. More...

#include "zoom_video_sdk_def.h"
#include "zoom_video_sdk_vector_interface.h"

Go to the source code of this file.

Classes
class	IZoomVideoSDKPhoneSupportCountryInfo
	Phone session support country information interface. More...
class	IZoomVideoSDKPhoneWelcomeMessageInfo
	Phone welcome message multilingual information interface. More...
class	IZoomVideoSDKSessionDialInNumberInfo
	Dial-in meeting Interface. More...
struct	InvitePhoneUserInfo
	The info for InvitePhoneUser. More...
class	IZoomVideoSDKPhoneHelper
	zoom video sdk phone helper interface. More...

Enumerations
enum	ZoomVideoSDKDialInNumType { ZoomVideoSDKDialInNumType_None , ZoomVideoSDKDialInNumType_Toll , ZoomVideoSDKDialInNumType_TollFree }
	Type of telephone call. Here are more detailed structural descriptions. More...
enum	PhoneStatus {   PhoneStatus_None , PhoneStatus_Calling , PhoneStatus_Ringing , PhoneStatus_Accepted ,   PhoneStatus_Success , PhoneStatus_Failed , PhoneStatus_Canceling , PhoneStatus_Canceled ,   PhoneStatus_Cancel_Failed , PhoneStatus_Timeout }
	Status of telephone. Here are more detailed structural descriptions. More...
enum	PhoneFailedReason {   PhoneFailedReason_None , PhoneFailedReason_Busy , PhoneFailedReason_Not_Available , PhoneFailedReason_User_Hangup ,   PhoneFailedReason_Other_Fail , PhoneFailedReason_No_Answer , PhoneFailedReason_Block_No_Host , PhoneFailedReason_Block_High_Rate ,   PhoneFailedReason_Block_Too_Frequent }
	The reason for the failure of the telephone call. Here are more detailed structural descriptions. More...

Detailed Description

phone helper interface.

Definition in file zoom_video_sdk_phone_helper_interface.h.

Enumeration Type Documentation

PhoneFailedReason

enum PhoneFailedReason

The reason for the failure of the telephone call. Here are more detailed structural descriptions.

Enumerator
PhoneFailedReason_None	For initialization.
PhoneFailedReason_Busy	The telephone number is busy.
PhoneFailedReason_Not_Available	The telephone number is out of service.
PhoneFailedReason_User_Hangup	The user hangs up.
PhoneFailedReason_Other_Fail	Other reasons.
PhoneFailedReason_No_Answer	The user did not answer the call.
PhoneFailedReason_Block_No_Host	The invitation by phone is blocked by the system due to an absent host.
PhoneFailedReason_Block_High_Rate	The call-out is blocked by the system due to the high cost.
PhoneFailedReason_Block_Too_Frequent	To join the session, the invitee would press one on the phone. An invitee who fails to respond will encounter a timeout. If there are too many invitee timeouts, the call invitation feature for this session will be blocked.

Definition at line 168 of file zoom_video_sdk_phone_helper_interface.h.

{
    PhoneFailedReason_None,
    PhoneFailedReason_Busy,
    PhoneFailedReason_Not_Available,
    PhoneFailedReason_User_Hangup,
    PhoneFailedReason_Other_Fail,
    PhoneFailedReason_No_Answer,
    PhoneFailedReason_Block_No_Host,
    PhoneFailedReason_Block_High_Rate,
    PhoneFailedReason_Block_Too_Frequent,
};

PhoneStatus

enum PhoneStatus

Status of telephone. Here are more detailed structural descriptions.

Enumerator
PhoneStatus_None	No status.
PhoneStatus_Calling	In process of calling out.
PhoneStatus_Ringing	In process of ringing.
PhoneStatus_Accepted	Accept the call.
PhoneStatus_Success	Call successful.
PhoneStatus_Failed	Call failed.
PhoneStatus_Canceling	In process of canceling the response to the previous state.
PhoneStatus_Canceled	Cancel successfully.
PhoneStatus_Cancel_Failed	Cancel fails.
PhoneStatus_Timeout	Timeout.

Definition at line 139 of file zoom_video_sdk_phone_helper_interface.h.

{
    PhoneStatus_None,
    PhoneStatus_Calling,
    PhoneStatus_Ringing,
    PhoneStatus_Accepted,
    PhoneStatus_Success,
    PhoneStatus_Failed,
    PhoneStatus_Canceling,
    PhoneStatus_Canceled, 
    PhoneStatus_Cancel_Failed,
    PhoneStatus_Timeout,
};

ZoomVideoSDKDialInNumType

enum ZoomVideoSDKDialInNumType

Type of telephone call. Here are more detailed structural descriptions.

Enumerator
ZoomVideoSDKDialInNumType_None	For initialization.
ZoomVideoSDKDialInNumType_Toll	Paid.
ZoomVideoSDKDialInNumType_TollFree	Free.

Definition at line 72 of file zoom_video_sdk_phone_helper_interface.h.

{
    ZoomVideoSDKDialInNumType_None,    
    ZoomVideoSDKDialInNumType_Toll,    
    ZoomVideoSDKDialInNumType_TollFree,
};