Entrance of all the Phone Call Service. More...

#include "ZRCSDKTypes.h"

Data Structures
struct	SIPCallMemberInfo
	SIP call member info The SIPCallMemberInfo refers to member information in the SIP call. More...

struct	SIPCallConferenceInfo
	SIP call conference info The SIPCallConferenceInfo refers to call's info in merged calls. More...

struct	SIPCallRedirectInfo
	SIP call redirect info The SIPCallRedirectInfo refers to call's redirect info. For instance, the redirect info refers to the peer info which a SIP call is transferred to when using the transfer function. More...

struct	EmergencyCallAddress
	emergency call's address More...

struct	EmergencyCall
	Emergency call info The info about emergency call. More...

struct	SIPCallInfo
	SIP call info. More...

struct	SIPCallTransferInfo
	SIP call transfer info. More...

struct	SIPCallerID
	SIP caller ID. More...

struct	CloudPBXServiceInfo
	Zoom Phone info. More...

struct	SIPService
	SIP service info. More...

class	IPhoneCallServiceSink
	Phone call service event callback. More...

class	IPhoneCallService
	Phone call service interface. More...

Enumerations
enum	SIPCallStatus { SIPCallStatusInit = 0 , SIPCallStatusCallOutFailed , SIPCallStatusIncoming , SIPCallStatusRinging , SIPCallStatusNotFound , SIPCallStatusBusy , SIPCallStatusDeclined , SIPCallStatusNotAvailable , SIPCallStatusTimeout , SIPCallStatusAccepted , SIPCallStatusHold , SIPCallStatusInCall , SIPCallStatusTerminated , SIPCallStatusRemoteHold , SIPCallStatusBothHold , SIPCallStatusSessionInProgress , SIPCallStatusStayOnPhone }
	SIP call status. Here are more detailed structural descriptions. More...

enum	SIPCallConferenceRole { SIPCallConferenceRoleUnknown = 0 , SIPCallConferenceRoleHost , SIPCallConferenceRoleParticipant }
	SIP call conference role in merged calls. Here are more detailed structural descriptions. More...

enum	SIPCallSpamType { SIPCallSpamTypeNone = 0 , SIPCallSpamTypeNotSpam = 1 , SIPCallSpamTypeSpam = 2 , SIPCallSpamTypeMaybeSpam = 3 }
	SIP call spam type. Here are more detailed structural descriptions. More...

enum	SIPCallAttestLevel { SIPCallAttestLevelUndefined = -1 , SIPCallAttestLevelA = 0 , SIPCallAttestLevelB = 1 , SIPCallAttestLevelC = 2 }
	SIP call attest level. Here are more detailed structural descriptions. More...

enum	SIPCallThirdPartyType { SIPCallThirdPartyTypeDefault = 0 , SIPCallThirdPartyTypeTransfer = 1 }
	SIP call thirdparty type. Here are more detailed structural descriptions. More...

enum	EmergencyAddressType { EmergencyAddressTypeUnknown = 0 , EmergencyAddressTypeStatic = 1 , EmergencyAddressTypeDetect = 2 }
	emergency address type. Here are more detailed structural descriptions. More...

enum	SIPCallTransferInfoType { SIPCallTransferInfoTypeUnknown = -1 , SIPCallTransferInfoTypeBlind , SIPCallTransferInfoTypeWarm , SIPCallTransferInfoTypeWarmComplete , SIPCallTransferInfoTypeVoicemail }
	SIP call transfer type. Here are more detailed structural descriptions. More...

enum	SIPServiceStatus { SIPServiceStatusIdle = 0 , SIPServiceStatusRegistering , SIPServiceStatusRegFailed , SIPServiceStatusRegistered , SIPServiceStatusRinging , SIPServiceStatusCallingOut , SIPServiceStatusInCall }
	SIP service status. Here are more detailed structural descriptions. More...

enum	SIPCallTerminateReason { SIPCallTerminateReasonUnknown = 0 , SIPCallTerminateReasonByLocal , SIPCallTerminateReasonByRemote , SIPCallTerminateReasonByNetworkBreak , SIPCallTerminateReasonByInitAudioDeviceFailed , SIPCallTerminateReasonBySipServiceStopped }
	SIP call terminate reason. Here are more detailed structural descriptions. More...

Detailed Description

Entrance of all the Phone Call Service.

Since: Added in ZRC SDK 6.0.0

Definition in file IPhoneCallService.h.

Enumeration Type Documentation

◆ EmergencyAddressType

enum EmergencyAddressType

emergency address type. Here are more detailed structural descriptions.

Enumerator
EmergencyAddressTypeUnknown	Emergency address type is unknown.
EmergencyAddressTypeStatic	Emergency address type is static.
EmergencyAddressTypeDetect	Emergency address type is detect.

Definition at line 87 of file IPhoneCallService.h.

{
    EmergencyAddressTypeUnknown = 0,    
    EmergencyAddressTypeStatic = 1,     
    EmergencyAddressTypeDetect = 2,     
};

◆ SIPCallAttestLevel

enum SIPCallAttestLevel

SIP call attest level. Here are more detailed structural descriptions.

Enumerator
SIPCallAttestLevelUndefined	SIP call attest level is undefined.
SIPCallAttestLevelA	SIP call attest level is A, represents high attest level.
SIPCallAttestLevelB	SIP call attest level is B, represents medium attest level.
SIPCallAttestLevelC	SIP call attest level is C, represents low attest level.

Definition at line 65 of file IPhoneCallService.h.

{
    SIPCallAttestLevelUndefined = -1,   
    SIPCallAttestLevelA = 0,            
    SIPCallAttestLevelB = 1,            
    SIPCallAttestLevelC = 2             
};

◆ SIPCallConferenceRole

enum SIPCallConferenceRole

SIP call conference role in merged calls. Here are more detailed structural descriptions.

Enumerator
SIPCallConferenceRoleUnknown	SIP call conference role is unknown.
SIPCallConferenceRoleHost	SIP call conference role is host in merged calls.
SIPCallConferenceRoleParticipant	SIP call conference role is participant in merged calls.

Definition at line 42 of file IPhoneCallService.h.

{
    SIPCallConferenceRoleUnknown = 0,   
    SIPCallConferenceRoleHost,          
    SIPCallConferenceRoleParticipant,   
};

◆ SIPCallSpamType

enum SIPCallSpamType

SIP call spam type. Here are more detailed structural descriptions.

Enumerator
SIPCallSpamTypeNone	SIP call spam type is none.
SIPCallSpamTypeNotSpam	SIP call spam type is not spam.
SIPCallSpamTypeSpam	SIP call spam type is spam.
SIPCallSpamTypeMaybeSpam	SIP call spam type is maybe spam.

Definition at line 53 of file IPhoneCallService.h.

{
    SIPCallSpamTypeNone = 0,        
    SIPCallSpamTypeNotSpam = 1,     
    SIPCallSpamTypeSpam = 2,        
    SIPCallSpamTypeMaybeSpam = 3    
};

◆ SIPCallStatus

enum SIPCallStatus

SIP call status. Here are more detailed structural descriptions.

Enumerator
SIPCallStatusInit	SIP call's status is init.
SIPCallStatusCallOutFailed	SIP call's status is call out failed.
SIPCallStatusIncoming	SIP call's status is incoming.
SIPCallStatusRinging	SIP call's status is ringing.
SIPCallStatusNotFound	SIP call's status is not found.
SIPCallStatusBusy	SIP call's status is busy.
SIPCallStatusDeclined	SIP call's status is declined.
SIPCallStatusNotAvailable	SIP call's status is not available.
SIPCallStatusTimeout	SIP call's status is timeout.
SIPCallStatusAccepted	SIP call's status is accepted.
SIPCallStatusHold	SIP call's status is hold.
SIPCallStatusInCall	SIP call's status is in call.
SIPCallStatusTerminated	SIP call's status is terminated.
SIPCallStatusRemoteHold	SIP call's status is remote hold.
SIPCallStatusBothHold	SIP call's status is both hold.
SIPCallStatusSessionInProgress	SIP call's status is session in progress.
SIPCallStatusStayOnPhone	SIP call's status is stay on phone.

Definition at line 17 of file IPhoneCallService.h.

{
    SIPCallStatusInit = 0,              
    SIPCallStatusCallOutFailed,         
    SIPCallStatusIncoming,              
    SIPCallStatusRinging,               
    SIPCallStatusNotFound,              
    SIPCallStatusBusy,                  
    SIPCallStatusDeclined,              
    SIPCallStatusNotAvailable,          
    SIPCallStatusTimeout,               
    SIPCallStatusAccepted,              
    SIPCallStatusHold,                  
    SIPCallStatusInCall,                
    SIPCallStatusTerminated,            
    SIPCallStatusRemoteHold,            
    SIPCallStatusBothHold,              
    SIPCallStatusSessionInProgress,     
    SIPCallStatusStayOnPhone            
};

◆ SIPCallTerminateReason

enum SIPCallTerminateReason

SIP call terminate reason. Here are more detailed structural descriptions.

Enumerator
SIPCallTerminateReasonUnknown	SIP call terminate reason is unknown.
SIPCallTerminateReasonByLocal	SIP call terminate reason is local termination.
SIPCallTerminateReasonByRemote	SIP call terminate reason is remote termination.
SIPCallTerminateReasonByNetworkBreak	SIP call terminate reason is network break.
SIPCallTerminateReasonByInitAudioDeviceFailed	SIP call terminate reason is init audio device failed.
SIPCallTerminateReasonBySipServiceStopped	SIP call terminate reason is sip service stopped.

Definition at line 126 of file IPhoneCallService.h.

{
    SIPCallTerminateReasonUnknown = 0,              
    SIPCallTerminateReasonByLocal,                  
    SIPCallTerminateReasonByRemote,                 
    SIPCallTerminateReasonByNetworkBreak,           
    SIPCallTerminateReasonByInitAudioDeviceFailed,  
    SIPCallTerminateReasonBySipServiceStopped       
};

◆ SIPCallThirdPartyType

enum SIPCallThirdPartyType

SIP call thirdparty type. Here are more detailed structural descriptions.

Enumerator
SIPCallThirdPartyTypeDefault	SIP call thirdparty type is default.
SIPCallThirdPartyTypeTransfer	SIP call thirdparty type is transfer.

Definition at line 77 of file IPhoneCallService.h.

{
    SIPCallThirdPartyTypeDefault = 0,   
    SIPCallThirdPartyTypeTransfer = 1,  
};

◆ SIPCallTransferInfoType

enum SIPCallTransferInfoType

SIP call transfer type. Here are more detailed structural descriptions.

Enumerator
SIPCallTransferInfoTypeUnknown	SIP call transfer type is unknown.
SIPCallTransferInfoTypeBlind	SIP call transfer type is blind transfer.
SIPCallTransferInfoTypeWarm	SIP call transfer type is warm transfer.
SIPCallTransferInfoTypeWarmComplete	SIP call transfer type is warm complete.
SIPCallTransferInfoTypeVoicemail	SIP call transfer type is voicemail transfer.

Definition at line 98 of file IPhoneCallService.h.

{
    SIPCallTransferInfoTypeUnknown = -1,    
    SIPCallTransferInfoTypeBlind,           
    SIPCallTransferInfoTypeWarm,            
    SIPCallTransferInfoTypeWarmComplete,    
    SIPCallTransferInfoTypeVoicemail        
};

◆ SIPServiceStatus

enum SIPServiceStatus

SIP service status. Here are more detailed structural descriptions.

Enumerator
SIPServiceStatusIdle	SIP service status is idle.
SIPServiceStatusRegistering	SIP service status is registering.
SIPServiceStatusRegFailed	SIP service status is registration failed.
SIPServiceStatusRegistered	SIP service status is registered.
SIPServiceStatusRinging	SIP service status is ringing.
SIPServiceStatusCallingOut	SIP service status is calling out.
SIPServiceStatusInCall	SIP service status is in call.

Definition at line 111 of file IPhoneCallService.h.

{
    SIPServiceStatusIdle = 0,       
    SIPServiceStatusRegistering,    
    SIPServiceStatusRegFailed,      
    SIPServiceStatusRegistered,     
    SIPServiceStatusRinging,        
    SIPServiceStatusCallingOut,     
    SIPServiceStatusInCall          
};

Data Structures

Enumerations