JavaScript APIs

Zoho SalesIQ JavaScript APIs 

Zoho SalesIQ APIs are easy-to-use, quick-to-implement, designed to customize your Chat Widget based on your existing web presence and preferences.

Explore more about Zoho SalesIQ APIs and learn how to squeeze more power out of them for your business. 

How to Use?

You need to add the required JavaScript APIs in your website along with the Zoho SalesIQ Embed Code to control the behaviour of the Chat embedded in your website.

Note:
  • The JavaScript API code should be included after the Zoho SalesIQ Embed Code
  • All API code must be enclosed within the Zoho SalesIQ Global Handler "$zoho.salesiq.ready=function(embedinfo){}" 
  • You can call any number of JS APIs here
Example
  1. <script type="text/javascript">var $zoho= $zoho || {salesiq:{values:{},ready:function({}}};vard=document;s=d.createElement 
  2.  ("script");s.type="text/javascript";s.defer=true;s.src="https://salesiq.zoho.com/salesiq/float.ls 
  3. ?embedname=salesiq";t=d.getElementsByTagName("script")[0];t.parentNode.insertBefore(s,t);</script>
    
  4. <script>
  5. $zoho.salesiq.ready=function(embedinfo)
  6. {
  7.     # Insert your Zoho SalesIQ API here # 
  8. }
  9. </script>

Keywords:

  • <VARIABLE NAME>  This should be replaced with the exact value for the variable
  • Zoho SalesIQ Global Handler   All JavaScript APIs should be added inside the Zoho SalesIQ Global Handler "$zoho.salesiq.ready"
  • API  Explains the API format
  • Parameters   Explains the data to be given for an API
  • *Parameter – These values are must, to get the APIs working

 

  • The global handler provides the JSON object "embedinfo" as argument. This has the details of the chat widget.
embedinfo format

{

    embedtype : "float|button|window|agent",

    floatstatus : "initialized|maximized|minimized|closed"

}

Values Explained:

  • embedtype - float|button|window|agent

    The embedtype describes the type of chat widget that is loaded.

  • floatstatus - initialized|maximized|minimized|closed

    The floatstatus describes the status of the float type chat widget in the previous page.

    • maximized: The user has maximized the chat widget in the previous page
    • minimized: The user has minimized the chat widget in the previous page
    • closed: The user closed the chat widget in the previous page
    • initialized: The user did not perform any of the above actions in the previous page
    Note: Applicable only for the float type chat widget.

Top