Live Chat API Code | Javascript API to Customize Chat Events

.chat.mode()To set chat mode

Use this API if you need the chat to be initiated OnClick over the chat button. However it will work only if all required visitor informations are populated.

.chat.department()To set departments

This API allows you to display only the required departments in the pre-chat form. All other configured departments will be hidden regardless of their status. However Web Embed department settings should be configured as "Allow user to select department".

.chat.defaultdepartment()To set default department

This API allows you to set a default department in the pre-chat form and the visitors are allowed to select other department if needed. However Web Embed department settings should be configured as "Allow user to select department".

.chat.agent()To set default agent

Use this API to route the chat to a specific agent for the first half of the waiting time. If not picked, the chat will be routed to other available agents.

.chat.forward() To disable chat forwarding

Use this API to disable chat forwarding to other agents. If the assigned agent could not pick the chat within the first half of the waiting time, these chats will not be forwarded to other agents and will be added under missed.

.chat.title()To set title

This API allows you to set title for the chat. Disable the company logo in Web Embed settings to get the title displayed for Chat window, Float & Personalized Chat widget.

.chat.logo()To set logo

This API allows you to set logo for the chat widget. Make sure to enable the company logo in the Web Embed settings.

.chat.start()To start chat

You can use this API to initiate a chat, it should be invoked only on a JavaScript OnClick. Supported for all the type of embed.

.chat.complete()To End chat

You can use this API to end the chat; it should be invoked on the JavaScript OnClick.

.chat.systemmessages()To set system messages

You can use this API to customize the system messages displayed in the chat widget.

API

$zoho.salesiq.chat. systemmessages ({" < FIELD > ":" < MESSAGE > "});

Parameters

waiting : This message will be displayed when a visitor is waiting after initiating the chat.

offline : This message will be displayed when all of your agents are in offline mode.

busy : This message will be displayed to the visitors when all your agents are busy and the chat waiting time has expired.

busycomplete : This message will be displayed to the visitors after submitting their request when all the agents are busy.

engaged: When the number of concurrent chats for a user reaches the configured ‘User concurrent chat limit’, the status of the user will be set as Engaged. Set the message to be displayed for the visitors when all the users are engaged.

engagedcomplete: When the visitor is displayed with the engaged status message, he also has an option to register for a response. Once he submits his details for a response, this message will be displayed to him.

prechatmessage : This message will be displayed to the visitor before initiating the chat when Name, Email address and Contact number field are hidden in the chat widget.

feedbackcomplete : This message will be displayed to your visitors after submitting the feedback. Feedbacks are scaled from one to five, you can have your own specific text for each level.

Feedbackcomplete1

Feedbackcomplete2

Feedbackcomplete3

Feedbackcomplete4

Feedbackcomplete5

agentinfomessage : This message will be displayed in the "User Description Area" of the Personalized Chat Window. (Note: It's applicable only for Personalized Chat Window)

Example

<script>
```
$zoho.salesiq.ready=function(embedinfo)
```
```
{
```

    $zoho.salesiq.chat.systemmessages({"waiting":" Please wait while we connect you to the support representative"});

    $zoho.salesiq.chat.systemmessages({"offline":"Sorry, We are not available at the moment"});

    $zoho.salesiq.chat.systemmessages({"busy":"Sorry, All the agents are busy right now, Please try again later"});

    $zoho.salesiq.chat.systemmessages({"busycomplete":"Thanks for submitting your details, WIll call you back"});

    $zoho.salesiq.chat.systemmessages({"engaged": "Sorry! All the users are engaged in supporting other customers." });

    $zoho.salesiq.chat.systemmessage({"engagedcomplete": "Thanks for submitting your details, You will hear from us shortly",});

    $zoho.salesiq.chat.systemmessages({"prechatmessage":"Welcome to Zoho SalesIQ. How can we help you "});

    $zoho.salesiq.chat.systemmessages({"feedbackcomplete1":"Sorry, will improve our support"});

    $zoho.salesiq.chat.systemmessages({"feedbackcomplete2":"Please provide us your suggestion"});

    $zoho.salesiq.chat.systemmessages({"feedbackcomplete3":"Thanks for your feedback!"});

    $zoho.salesiq.chat.systemmessages({"feedbackcomplete4":"Thank you for your time"});

    $zoho.salesiq.chat.systemmessages({"feedbackcomplete5":"Wow Thanks"});

    $zoho.salesiq.chat.systemmessages({"agentinfomessage":"Would you need any help?"});

```
}
```
</script>

Keep Less

.salesiq.language()To set language for embed chat

This API allows you to set a language for the Chat Widget. Make sure you enter the code in the LANGUAGE CODE variable.

.chat.theme()To Customize Chat Theme Color

This API allows you to customize your theme color.

Chat APIs

$zoho.salesiq.chat

Table of Contents

.chat.mode()To set chat mode

.chat.department()To set departments

.chat.defaultdepartment()To set default department

.chat.agent()To set default agent

.chat.forward() To disable chat forwarding

.chat.title()To set title

.chat.logo()To set logo

.chat.start()To start chat

.chat.complete()To End chat

.chat.systemmessages()To set system messages

.salesiq.language()To set language for embed chat

.chat.theme()To Customize Chat Theme Color

Was this article helpful? Yes, thanks!Not really

Still can't find what you're looking for?