Client SDK 

Overview   

Zoho Voice WebSDK allows you to make and receive calls directly from any web browser that supports webRTC. Using our SDK you can create applications like click-to call, conferencing apps and even webphones.  

 Including The Javascript:   

Include the Zoho Voice javascript file as shown below

Without Dialpad UI  
<script src="https://js.zohostatic.com/zvoice_plugin/latest/js/zohovoice.min.js"></script>

With Dialpad UI                
<script src="https://js.zohostatic.com/zvoice_plugin/latest/js/zohovoice-ui.min.js"></script>

 Initializing The Zoho Voice Object:   

The Zoho Voice WebSDK object needs to be initialized.

    var options = { 
        agentKey:'xxxxxxxxxxxxxxx', //Zoho Voice Agent key
        zsoid:"12345",  //Zoho Voice ZSOID
        name:'John', //Callee Display Name
        number:'1234', //Zoho Voice username
        password:'1234', //Zoho Voice password
        outgoingNumber:{    //default outgoing number
            number:"123456789",
            numberId:"123456789",
            isDefault:true
        }
        outgoingNumberList:[{
            number:"123456789",
            numberId:"123456789",
            isDefault:true
        },{
            number:"123456788",
            numberId:"123456788",
            isDefault:false
        }] //Zoho Outgoing List
    }
    var zohovoice = new ZohoVoice(options);

Event Registration:   

Pass function references to the events produced from the SDK. This is where your UI manipulation should handle all the different call flows.

Callback Events:  

 
    regState
    // Triggered when registration state change
    on('regState', function(regObject) {})
    //regObject response
    {
        status:'connecting',    //No I18N
        username:self.opts.username
    }
    //regState Status(connecting,registered,failed,error,disconnected,websocket closed,unregistered)
        
    callState
    // Triggered when call state change
    on('callState', function(callerObject) {})
    //callerObject response
    /*
    {            
        callId: "6d2bcd2a-e87a-4518-91dc-52ed3caee986"
        callStatus: "connected"
        didName: "Direct Agent"
        didNumber: "14695016096"
        duration: "00:00"
        id: "14695016095-1625564868881"
        isAccepted: true
        isCallStarted: true
        isConf: false
        isConnecting: true
        isExtension: false
        isInCall: true
        isMissed: false
        isOutgoing: false
        isSecondCall: false
        name: "Unknown"
        number: "14695016095"
        startTime: 1625564868881
    }
    */
    //callState callStatus(incoming,connecting,ringing,connected,callend)

    error
    // Triggered when error occured
    on('error', function(errorObject) {})
    //errorObject response
    /*
    {            
        code: 1,
        desc:'Error message'
    }
    */

    login
    // Triggered when login
    on('login', function() {})

    logout
    // Triggered when logout
    on('logout', function() {})

    regeneratepassword
    // Triggered when regeneratepassword
    on('regeneratepassword', function() {})

    regeneratepassword
    // Triggered when regeneratepassword
    on('regeneratepassword', function() {})

    forgotpassword
    // Triggered when forgotpassword
    on('forgotpassword', function() {})

    ready
    //Triggered on element created
    on('ready', function() {})

    agentStatus
    //Triggered on agentStatus update
    on('agentStatus', function() {})


    getLogs
    //Triggered on to get logs
    on('getLogs', function(logsParam, callBack) {})
    /*
    logsParam = {
        userNumber:'',
        from:0,
        size:100
    }
    //logs response should be pass in callback as bellow
    callBack([{
        toNumber:"+12345678990",
        dateTime:1556186162570,
        duration:"00:00:00"
    }])
    */

    //Triggered to update call duration while call is running
    on('timer', function(tObj) {})

    //Triggered on mediaDeviceChange
    on('mediaDeviceChange', function(tObj) {})
    
    //Triggered on microphoneChange
    on('microphoneChange', function(tObj) {})

    //Triggered on voice sdk destroy
    on('destroy', function(tObj) {})
    
    //Triggered to setFavourite
    on('setFavourite', function(tObj) {})

    //Triggered to setFavourite outgoing number
    on('setFavourite', function(obj, callBack) {})

    //Triggered to getNumberSuggestion
    on('getNumberSuggestion', function(str, isQueue, callBack) {})

    //Triggered to getVoiceMailSuggestion
    on('getVoiceMailSuggestion', function(str, callBack) {})

    //Triggered to getTurnServers
    on('getTurnServers', function(callBack) {})

    //Triggered to getQueueName
    on('getQueueName', function(queueId, callBack) {})

    //Triggered on outgoing call is initiated
    on('makeCall', function(cInfo) {})

    //Triggered to updateCallerInfo
    on('updateCallerInfo', function(cInfo) {})

    //Triggered to get outgoingNumberList
    on('outgoingNumberList', function() {})

    //Triggered on callnote update
    on('callnote', function(cList) {})

    transferStaus
    on('transferStaus', function(transferObj){});
    //transferObj response
    {
        callerNumber: "xxxxxxxx",
        callerName: "xxxxxxxx",
        callId: "6d2bcd2a-e87a-4518-91dc-52ed3caee986",
        callTransfered: true,
        departmentName: "SampleDept",
        duration: "00:00",
        emailid: "sample@abc.com",
        extension: 98750,
        name: "Test Name",
        number: "xxxxx",
        isTransferCall: true, //on caller C
        onlineStatus: "Available",
        serviceName: "ServiceABC",
        transferId: 1625564926802,
        status: {type: "caller", status: "unhold"}
    }
    //status response
    {type:"transfer", status:"dialing"} //on transfer call dialing a agent/queue
    {type:"transfer", status:"ringing"} //on transfer call ringing a agent/queue
    {type:"transfer", status:"bridged"} //on transfer call agent has disconnected
    {type:"transfer", status:"unavailable"} //on transfer call agent is not available
    {type:"threeway", status:"bridged"} //call has merged on transfer call
    {type:"caller", status:"hold"}  //on transfer caller A as on hold
    {type:"caller", status:"unhold"} //on transfer caller A as on unhold
    {type:"caller", status:"hangup"} //on transfer caller A has disconnected the call

    //Example for listening events
    var zohovoice= new ZohoVoice(options);
    zohovoice.on('regState', function({
      //Create what you want
    });

SDK Reference   

The following are the configuration parameters:

Zoho Voice Methods   

These are the methods supported

Mobile Android SDK
Overview

This document gives an overview of different classes and methods available in ZohoVoiceSDK Android SDK V1.0.0

Initialize Zoho Voice   

                
        ZohoVoiceSDK mZohoVoiceSDK = ZohoVoiceSDK.newInstance(context, new ZVSDKCallBack() {
            @Override
            public void onRegStateChanged(regState state, ZVAccount account) {
                //In state param, you will get any of these statuses:
                //"REG_FAILED, REG_BADGATEWAY, REG_SUCCESS, REG_UNAUTHORIZED, REG_UNREGISTERED, REG_TIMEOUT, REG_PROGRESS"
            }
            public void onAddConference() { }
            public void onIncomingCall(CallerInfo cInfo) {}
            public void onCallStateChanged(CallState state, final CallerInfo callerInfo) {
                //In state param, you will get any of these statuses:
              //CallState.RINGING CallState.CONFIRMED
            }
            public void onCallEnd(final CallerInfo cInfo, CallState reason) {
                //In state param, you will get any of these statuses:
                //CallState.CALL_END, CallerInfo.callMode.MISSED
            }
            public void onError() {}
            public void onPermissionError(String error) {}
            public void onSuggestionRequest(String str, final SuggestionCallBack callBack) {
                //callBack.onResponse(new ArrayList());          
            }
            public void onNetworkChanged(NetworkState networkState) {
                //In networkState param, you will get any of these statuses:
                //NetworkState.ONLINE, NetworkState.OFFLINE
            }
            public void onApplicationResume() { }
            public void onApplicationStopped() {}
        });
            

Register Application Lifecycle   

Call the below method in Android Application Class.

            registerActivityLifecycleCallbacks(mZohoVoiceSDK);
        

Add Account   

            ZVAccount account = new ZVAccount();
account.setUsername("12345");
account.setPassword("*******");
HashMap sipHeader = new HashMap<>();
sipHeader.put("X-apikey", "XXX-XXXX-XXXX-XXX");
account.setCallHeaders(sipHeader);
mZohoVoiceSDK.addAccount(account);
        

Make Call   

            CallerInfo cInfo = new CallerInfo();
cInfo.setNumber("12345");
cInfo.setName("John");
mZohoVoiceSDK.makeCall(cInfo);
        

Update Caller Info   

            CallerInfo cInfo = new CallerInfo();
cInfo.setNumber("12345");
cInfo.setName("John");
mZohoVoiceSDK.updateCallerInfo(cInfo);
        

Check Account Registration   

Use the below method to check whether the account is registered or not.

            mZohoVoiceSDK.isRegistered("12345");
        

Mobile iOS SDK   

Initialize Zoho Voice   

Call the below method in application delegate class.

                var zohovoice = ZohoVoiceSDK.initWith(self.window!);
            

Add Account   

Use the below method to register with Zoho Voice.

                
    let zvconf = ZVAccount()
    zvconf.name = "ZohoVoice"
    zvconf.username = "123456789"
    zvconf.password = "123456"
        
    var error:NSError?
    zohovoice.addAccount(zvconf, &error)
            

Make Call   

Use the below method to make a call.

                
    //Using CallerInfo object in the below format, pass it as an argument.
    let cInfo = CallerInfo()
    cInfo.name = "John"
    cInfo.number = "12345"
    cInfo.peofileImage = "image  url"
    zohovoice.makeCall(cInfo, completion: { (error:Error?) in
             if(error != nil){
                   print("Make Call Error \(error?.localizedDescription)")
             }
    })
            

Add Observer   

Listen to this observer to get the call status.

//Call Status Observer    
NotificationCenter.default.addObserver(self, selector: #selector(self.onZVSDKCallStatus), name: NSNotification.Name(rawValue: "ZVSDKStatusNotification"), object: nil)

//Dialer Search Observer
NotificationCenter.default.addObserver(self, selector:#selector(self.onDialerSearch), name:NSNotification.Name(rawValue:"ZVDialerSearch"), object:nil)

 Call Status Observer Method   

        
    @objcfunconZVSDKCallStatus(notification:NSNotification){

        let data = notification.userInfo as! [String:Any]

        //In the "type" Key, you will get any of these values: "incoming","outgoing","registration","unregistered","removeaccount"
        let type = data["type"] as! String  

        //In the "status" Key, your will get  any of these values: "ringing", "callend", "success", "failure", "timeout", "connecting", "unauthorized", "completed"
        let status = data["status"] as! String      
    
        //When type is "incoming" || "outgoing", status value will be "ringing" || "callend"
        if type == "incoming" || type == "outgoing"{
            if(status == "ringing"){

            }
            //When status is "callend", you will get the value in "reason" Key. For Ex: "User Busy"   
            if status == "callend"{
               let callerInfo:CallerInfo = data["data"] as! CallerInfo
               let reason = data["reason"] = "busy, callend, disconnected by user, Busy Here"

            }
        } 
        
        //When type is "registration" you will get any of these status: "success", "failure", "timeout", "connecting", "unauthorized"
        if type == "registration"{
      if status == "success"{

            }else if status == "failure" || status == "timeout"{

            }else if status == "connecting"{

            }else if status == "unauthorized"{

            }
        }
            
        if type == "unregistered"{
            
        }
            
        //When type is "removeaccount" you will get any of these status: "success", "failure", "completed"
        if type == "removeaccount"{
            if status == "success"{

            }else if status == "failure"{

            }else if status == "completed"{

            }
        }
            
    }

Dialer Search Observer Method   

@objcfunconDialerSearch(notification:NSNotification){

    let data = notification.userInfo as! [String:Any]
    // The search value will return in "searchStr" key. Use this value to search the "Contacts" from your database.
    let searchStr = data["searchStr"] as! String

    // Using UserModel object in the below format, construct as array.
    let user = UserModel()
    user.name = "SampleName"
    user.emailid = "sample@abc.com"
    user.number = "12345"
    user.mobile = "123456789"
    user.id = 123456
    user.image = "image url"
        
    let searchData:[String:Any] = ["result":[user]()]
    
    //Post the array object to "ZVDialerSearchResult"
    NotificationCenter.default.post(name: NSNotification.Name(rawValue: "ZVDialerSearchResult"), object: nil, userInfo: searchData)
}