zoom_video_sdk_phone_helper_interface.h

Go to the documentation of this file.

 
#ifndef _ZOOM_VIDEO_SDK_PHONE_INTERFACE_H_
#define _ZOOM_VIDEO_SDK_PHONE_INTERFACE_H_
#include "zoom_video_sdk_def.h"
#include "zoom_video_sdk_vector_interface.h"
 
BEGIN_ZOOM_VIDEO_SDK_NAMESPACE
class IZoomVideoSDKPhoneSupportCountryInfo
{
public:
    virtual ~IZoomVideoSDKPhoneSupportCountryInfo() {}
    
    virtual const zchar_t* getCountryID() = 0;
    
    virtual const zchar_t* getCountryName() = 0;
    
    virtual const zchar_t* getCountryCode() = 0;
};

class IZoomVideoSDKPhoneWelcomeMessageInfo
{
public:
    virtual ~IZoomVideoSDKPhoneWelcomeMessageInfo() {}

    virtual const zchar_t* getLanguageCode() = 0;

    virtual const zchar_t* getLanguageName() = 0;

    virtual const zchar_t* getVariantId() = 0;
};

enum ZoomVideoSDKDialInNumType
{
    ZoomVideoSDKDialInNumType_None,    
    ZoomVideoSDKDialInNumType_Toll,    
    ZoomVideoSDKDialInNumType_TollFree,
};

class IZoomVideoSDKSessionDialInNumberInfo
{
public:
    virtual ~IZoomVideoSDKSessionDialInNumberInfo() {}
    
    virtual const zchar_t* getCountryId() = 0;
    
    virtual const zchar_t* getCountryCode() = 0;
    
    virtual const zchar_t* getCountryName() = 0;
    
    virtual const zchar_t* getNumber() = 0;
    
    virtual const zchar_t* getDisplayNumber() = 0;
    
    virtual ZoomVideoSDKDialInNumType  getType() = 0;
    
    virtual bool isDedicateID() = 0;
};
 

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

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,
};

struct InvitePhoneUserInfo
{
    const zchar_t* countryCode;
    const zchar_t* phoneNumber;
    const zchar_t* name;
    bool bPressOne;
    bool bGreeting;
    bool bDetectMachine;
    const zchar_t* languageCode;
    const zchar_t* variantId;
 
    InvitePhoneUserInfo()
    {
        countryCode = nullptr;
        phoneNumber = nullptr;
        name = nullptr;
        bPressOne = true;
        bGreeting = true;
        bDetectMachine = false;
        languageCode = nullptr;
        variantId = nullptr;
    }
};

class IZoomVideoSDKPhoneHelper
{
public:
    virtual bool isSupportPhoneFeature() = 0;
    
    virtual IVideoSDKVector<IZoomVideoSDKPhoneSupportCountryInfo* >* getSupportCountryInfo() = 0;

    virtual IVideoSDKVector<IZoomVideoSDKPhoneWelcomeMessageInfo*>* getPhoneWelcomeMessageInfoList() = 0;
    
    virtual ZoomVideoSDKErrors inviteByPhone(const zchar_t* countryCode, const zchar_t* phoneNumber, const zchar_t* name) = 0;
    
    virtual ZoomVideoSDKErrors invitePhoneUser(const InvitePhoneUserInfo& inviteInfo) = 0;
    
    virtual ZoomVideoSDKErrors cancelInviteByPhone() = 0;
    
    virtual PhoneStatus getInviteByPhoneStatus() = 0;
    
    virtual IVideoSDKVector<IZoomVideoSDKSessionDialInNumberInfo*>* getSessionDialInNumbers() = 0;
};
 
END_ZOOM_VIDEO_SDK_NAMESPACE
#endif