IPhoneCallService.h

Go to the documentation of this file.

 
#ifndef ZRC_IPHONECALLSERVICE_H
#define ZRC_IPHONECALLSERVICE_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum SIPCallStatus
{
    SIPCallStatusInit = 0,              
    SIPCallStatusCallOutFailed,         
    SIPCallStatusIncoming,              
    SIPCallStatusRinging,               
    SIPCallStatusNotFound,              
    SIPCallStatusBusy,                  
    SIPCallStatusDeclined,              
    SIPCallStatusNotAvailable,          
    SIPCallStatusTimeout,               
    SIPCallStatusAccepted,              
    SIPCallStatusHold,                  
    SIPCallStatusInCall,                
    SIPCallStatusTerminated,            
    SIPCallStatusRemoteHold,            
    SIPCallStatusBothHold,              
    SIPCallStatusSessionInProgress,     
    SIPCallStatusStayOnPhone            
};
 
enum SIPCallConferenceRole
{
    SIPCallConferenceRoleUnknown = 0,   
    SIPCallConferenceRoleHost,          
    SIPCallConferenceRoleParticipant,   
};
 
enum SIPCallSpamType
{
    SIPCallSpamTypeNone = 0,        
    SIPCallSpamTypeNotSpam = 1,     
    SIPCallSpamTypeSpam = 2,        
    SIPCallSpamTypeMaybeSpam = 3    
};
 
enum SIPCallAttestLevel
{
    SIPCallAttestLevelUndefined = -1,   
    SIPCallAttestLevelA = 0,            
    SIPCallAttestLevelB = 1,            
    SIPCallAttestLevelC = 2             
};
 
enum SIPCallThirdPartyType
{
    SIPCallThirdPartyTypeDefault = 0,   
    SIPCallThirdPartyTypeTransfer = 1,  
};
 
enum EmergencyAddressType
{
    EmergencyAddressTypeUnknown = 0,    
    EmergencyAddressTypeStatic = 1,     
    EmergencyAddressTypeDetect = 2,     
};
 
enum SIPCallTransferInfoType
{
    SIPCallTransferInfoTypeUnknown = -1,    
    SIPCallTransferInfoTypeBlind,           
    SIPCallTransferInfoTypeWarm,            
    SIPCallTransferInfoTypeWarmComplete,    
    SIPCallTransferInfoTypeVoicemail        
};
 
enum SIPServiceStatus
{
    SIPServiceStatusIdle = 0,       
    SIPServiceStatusRegistering,    
    SIPServiceStatusRegFailed,      
    SIPServiceStatusRegistered,     
    SIPServiceStatusRinging,        
    SIPServiceStatusCallingOut,     
    SIPServiceStatusInCall          
};
 
enum SIPCallTerminateReason
{
    SIPCallTerminateReasonUnknown = 0,              
    SIPCallTerminateReasonByLocal,                  
    SIPCallTerminateReasonByRemote,                 
    SIPCallTerminateReasonByNetworkBreak,           
    SIPCallTerminateReasonByInitAudioDeviceFailed,  
    SIPCallTerminateReasonBySipServiceStopped       
};
 
struct SIPCallMemberInfo
{
    std::string            name;                                        
    std::string            number;                                      
    SIPCallAttestLevel     attestLevel = SIPCallAttestLevelUndefined;   
};
 
struct SIPCallConferenceInfo
{
    SIPCallConferenceRole role = SIPCallConferenceRoleUnknown;  
    std::string                  hostCallID;                    
};
 
struct SIPCallRedirectInfo
{
    SIPCallThirdPartyType endType = SIPCallThirdPartyTypeDefault;   
    std::string           endName;                                  
    std::string           endNumber;                                
};
 
struct EmergencyCallAddress
{
    EmergencyAddressType addressType = EmergencyAddressTypeUnknown; 
    std::string          address;                                   
};
 
struct EmergencyCall
{
    EmergencyCallAddress        emergencyCallAddress;               
    bool                        locationPermissionEnabled = false;  
    std::vector<std::string>    customEmergencyNumbers;             
};
 
struct SIPCallInfo
{
    SIPCallStatus                   status = SIPCallStatusInit;                     
    std::string                     callID;                                         
    std::string                     peerDisplayName;                                
    std::string                     peerNumber;                                     
    std::string                     peerURI;                                        
    bool                            isIncomingCall = false;                         
    SIPCallMemberInfo               selfInfo;                                       
    SIPCallConferenceInfo           conferenceInfo;                                 
    std::vector<SIPCallMemberInfo>  remoteMembers;                                  
    int64_t                         elapsedCallTime = -1;                           
    std::string                     relatedCallID;                                  
    std::string                     blindDisplayName;                               
    std::string                     originalPeerURI;                                
    SIPCallSpamType                 peerSpamType = SIPCallSpamTypeNone;             
    SIPCallAttestLevel              peerAttestLevel = SIPCallAttestLevelUndefined;  
    SIPCallRedirectInfo             redirectInfo;                                   
    bool                            isEmergencyCall = false;                        
    EmergencyCallAddress            emergencyCallAddress;                           
};
 
struct SIPCallTransferInfo
{
    SIPCallTransferInfoType type = SIPCallTransferInfoTypeUnknown;  
    std::string             peerURI;                                
};
 
struct SIPCallerID
{
    std::string name;           
    std::string number;         
    std::string extensionID;    
};
 
struct CloudPBXServiceInfo
{
    std::string              extension;                                 
    std::string              companyNumber;                             
    std::vector<std::string> directNumbers;                             
    std::string              countryCode;                               
    std::string              countryName;                               
    std::string              areaCode;                                  
    std::vector<SIPCallerID> callerIDs;                                 
    std::string              formattedCompanyNumber;                    
    std::vector<std::string> formattedDirectNumbers;                    
    bool                     isEnabledMakeOutBoundPSTNCall = false;     
    bool                     isEnabledHaveADID = false;                 
    bool                     isEnable911Call =false;                    
    EmergencyCall            emergencyCall;                             
};
 
struct SIPService
{
    SIPServiceStatus    status = SIPServiceStatusIdle;  
    std::string         userName;                       
    std::string         displayName;                    
    int32_t             responseCode = 0;               
    std::string         responseDescription;            
    bool                isZoomPhoneAvailable = false;   
    CloudPBXServiceInfo cloudPBXServiceInfo;            
};
 
class IPhoneCallServiceSink
{
public:
    virtual ~IPhoneCallServiceSink() {}
 
    virtual void OnAnswerSIPCallResult(bool succeeded, const SIPCallInfo& sipCallInfo, bool accepted) = 0;
 
    virtual void OnAcceptSIPCallToMeetingResult(bool succeeded, const SIPCallInfo& sipCallInfo) = 0;
 
    virtual void OnUpdateSIPCallPeerResult(bool succeeded, const SIPCallInfo& sipCallInfo) = 0;
 
    virtual void OnUpdateSIPCallAudioResult(bool succeeded) = 0;
 
    virtual void OnTransferSIPCallResult(bool succeeded, const SIPCallInfo& sipCallInfo, const SIPCallTransferInfo& transferInfo) = 0;
 
    virtual void OnUpgradeSIPCallToMeetingResult(bool succeeded, const SIPCallInfo& sipCallInfo) = 0;
 
    virtual void OnReceiveIncomingSIPCallNotification(const SIPCallInfo& sipCallInfo) = 0;
 
    virtual void OnTreatSIPCallNotification(bool accepted, const SIPCallInfo& sipCallInfo) = 0;
 
    virtual void OnInviteSIPCallToJoinMeetingNotification(const SIPCallInfo& sipCallInfo) = 0;
 
    virtual void OnTerminateSIPCallNotification(SIPCallTerminateReason reason, const SIPCallInfo& sipCallInfo) = 0;
 
    virtual void OnUpdateSIPCallAudioStatusNotification(bool muted) = 0;
 
    virtual void OnUpdateSIPCallStatusNotification(const SIPCallInfo& sipCallInfo) = 0;
 
    virtual void OnTransferSIPCallNotification(bool succeeded, const SIPCallInfo& sipCallInfo) = 0;
 
    virtual void OnUpgradeSIPCallToMeetingNotification(bool succeeded, const SIPCallInfo& sipCallInfo) = 0;
 
    virtual void OnUpdateSIPServiceStatusNotification(const SIPService& sipService) = 0;
};
 
class IPhoneCallService
{
public:
    virtual ~IPhoneCallService() {}
 
    virtual ZRCSDKError RegisterSink(IPhoneCallServiceSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IPhoneCallServiceSink* pSink) = 0;
 
    virtual ZRCSDKError AcceptIncomingSIPCall(const SIPCallInfo& sipCallInfo) = 0;
 
    virtual ZRCSDKError HoldAndAcceptIncomingSIPCall(const SIPCallInfo& sipCallInfo) = 0;
 
    virtual ZRCSDKError EndAndAcceptIncomingSIPCall(const SIPCallInfo& sipCallInfo) = 0;
 
    virtual ZRCSDKError DeclineIncomingSIPCall(const SIPCallInfo& sipCallInfo) = 0;
 
    virtual ZRCSDKError AcceptSIPCallToMeeting(const SIPCallInfo& sipCallInfo) = 0;
 
    virtual ZRCSDKError DeclineSIPCallToMeeting(const SIPCallInfo& sipCallInfo) = 0;
 
    virtual ZRCSDKError CallSIP(const std::string& uri) = 0;
 
    virtual ZRCSDKError HangupSIPCall(const SIPCallInfo& sipCallInfo) = 0;
 
    virtual ZRCSDKError MuteSIPCallAudio(bool mute) = 0;
 
    virtual ZRCSDKError SendDTMFToSIPCall(const std::string& dtmf, const SIPCallInfo& sipCallInfo) = 0;
 
    virtual ZRCSDKError HoldSIPCall(const SIPCallInfo& sipCallInfo) = 0;
 
    virtual ZRCSDKError UnholdSIPCall(const SIPCallInfo& sipCallInfo) = 0;
 
    virtual ZRCSDKError MergeSIPCall(const SIPCallInfo& hostSIPCallInfo, const SIPCallInfo& participantSIPCallInfo) = 0;
 
    virtual ZRCSDKError TransferSIPCall(const SIPCallInfo& sipCallInfo, const SIPCallTransferInfo& transferInfo) = 0;
 
    virtual ZRCSDKError CompleteWarmTransfer(const SIPCallInfo& sipCallInfo) = 0;
 
    virtual ZRCSDKError CancelWarmTransfer(const SIPCallInfo& sipCallInfo) = 0;
 
    virtual ZRCSDKError UpgradeSIPCallToMeeting(const SIPCallInfo& sipCallInfo, bool isEndCurrentMeeting) = 0;
 
    virtual ZRCSDKError SetLocationPermissionEnable(bool enable) = 0;
 
    virtual ZRCSDKError GetLocationPermissionEnable(bool& enable) = 0;
 
    virtual ZRCSDKError GetSIPCallList(std::vector<SIPCallInfo>& sipCalls) = 0;
 
    virtual ZRCSDKError GetUnholdSIPCall(SIPCallInfo& unholdCall) = 0;
};
 
NS_ZRCSDK_END
#endif    //ZRC_IPHONECALLSERVICE_H