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 = { 
               development:false,
               debug:false,
               draggable:true,
           }] //Zoho Outgoing List
   }
   var zohovoice = new ZohoVoice(options);
   
   //Authenticate via accounts session
   zohovoice.ajaxOpts.domain = 'http://app.zoho.com';  // replace your domain name
   zohovoice.ajaxOpts.csrf = {key:'CSRF_KEY', value:'zvtpname'}; //replace key name to your CSRF cookie name


   //Authenticate via OAuth Token
   zohovoice.ajaxOpts.isOAuth = true;
   zohovoice.ajaxOpts.oAuthCallBack = (callBack) => {
       callBack(token)
   }

   zohovoice.initialize();
   

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.

 
   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() {})

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

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

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

   //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 updateCallerInfo
   on('updateCallerInfo', function(cInfo) {})

   transferStaus
   on('transferStaus', function(transferObj){});
   //transferObj response
   {
       callerNumber: "xxxxxxxx",
       callerName: "xxxxxxxx",
       callId: "6d2bcd2a-e87a-4518-91dc-52ed3caee986",
       callTransfered: true,
       departmentName: "AlarmsOne",
       duration: "00:00",
       emailid: "brindha.r+101@zohotest.com",
       extension: 98750,
       name: "brindha 101 Tech",
       number: "58421713_4501000000516029",
       isTransferCall: true, //on caller C
       onlineStatus: "Available",
       serviceName: "ZohoVoice",
       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