api.zopim.com$zopim.livechat - Javascript API

Zopim is now called Zendesk Chat. All API functionality will continue to work as normal and the namespace will not change in the immediate future. Help Dashboard Account PRODUCT PRICING CONTACT SIGN UP Javascript API Javascript API New Widget NewWidget $zopim. livechat LiveChatAPI $zopim. livechat. badge $zopim. livechat. button $zopim. livechat. bubble $zopim. livechat. window $zopim. livechat. concierge $zopim. livechat. theme $zopim. livechat. departments $zopim. livechat. cookieLaw $zopim. livechat. offlineForm $zopim. livechat. prechatForm $zopim. livechat. mobileNotifications $zopim. livechat Zopim Live Chat API The Javascript API lets you customize various aspects of the Zopim Live Chat Widget. You can use a different color scheme on a special marketing page, set the widget language based on the user’s preferences and much more. Need more customizations? If you are currently on the Chat Enterprise or Premium (Legacy) plan, you have the flexibility of fully customizing the entire chat widget by developing your own using the Zendesk Chat Web SDK. For more information, head to https://api.zopim.com/web-sdk for details. Using the Web Widget with integrated Chat experience enabled? If you are using the Web Widget with the integrated Chat experience enabled, head to https://developer.zendesk.com /embeddables /docs /widget /chat for more information on the Javascript APIs supported. If you are migrating from the old experience to the new integrated experience in the Web Widget, go to https://developer.zendesk.com /embeddables /docs /widget /chat_api_migration for more information regarding the migration process. Usage API calls must be inserted after the Live Chat Script and wrapped within $zopim(function() { ... }) Examples script $zopim(function() { $zopim.livechat.setName(’Logged in name’); $zopim.livechat.setEmail(’user@somewhere.com’); }); /script Note : Some API calls are unavailable for accounts using the Lite package. Summary $zopim. livechat The Javascript API lets you customize various aspects of the Zopim Live Chat Widget. Functions getName Get the name of the visitor. getEmail Get the email address of the visitor. getPhone Get the phone number of the visitor. isChatting Check whether a chat session is in progress. set A convenience function to set multiple settings at once. setName Set the visitor’s name. setEmail Set the visitor’s email address. setPhone Set the visitor’s phone number. addTags Add tag(s) to the current chat session. sendVisitorPath Programmatically update visitor’s webpath. removeTags Remove tag(s) from the current chat session. setDisableSound Configure whether sound notifications are played. setDisableGoogleAnalytics Configure whether events should be sent to Google Analytics. setLanguage Set the widget language. setGreetings Set the greeting messages displayed on the chat button for each status on the desktop widget. clearAll Clear all visitor data and register as a new visitor. hideAll Hide the widget completely. say Make the visitor send a message. setOnConnected Register a callback to be fired when the widget successfully connects to the server. setOnChatStart Register a callback to be fired when a chat starts. setOnChatEnd Register a callback to be fired when a chat ends. setOnStatus Register a callback to be fired when the account status changes. setOnUnreadMsgs Register a callback to be fired when the number of unread messages changes. endChat End the current chat session. setStatus Set the widget account status. setNotes Set the visitor’s notes. appendNotes Append to the visitor’s notes. authenticate Authenticates the visitor using JSON Web Tokens. Functions getName function getName() Get the name of the visitor. Example script $zopim(function() { alert("Visitor’s name: " + $zopim.livechat.getName()); }); /script getEmail function getEmail() Get the email address of the visitor. Example script $zopim(function() { alert("Visitor’s email: " + $zopim.livechat.getEmail()); }); /script getPhone function getPhone() Get the phone number of the visitor. Example script $zopim(function() { alert("Visitor’s phone: " + $zopim.livechat.getPhone()); }); /script isChatting function isChatting() Check whether a chat session is in progress. set function set( settings ) A convenience function to set multiple settings at once. Accepts a settings object. Note : This API will not change verified information (e.g., name) if the visitor is authenticated. Parameters settings object An object of properties to be updated and their expected values (settings_name = value pairs) Example script $zopim(function() { $zopim.livechat.set({ language: ’en’, name: ’Visitor’, email: ’visitor@site.com’ }); }); /script setName function setName( name ) Set the visitor’s name. Note : This API will not work if the visitor is authenticated. Parameters name Visitor’s name - cannot exceed 255 characters in length setEmail function setEmail( email ) Set the visitor’s email address. Note : This API will not work if the visitor is authenticated. Parameters email Visitor’s email address setPhone function setPhone( phone ) Set the visitor’s phone number. Parameters phone Visitor’s phone number - cannot exceed 25 characters in length addTags function addTags( /* tag1[, tag2[, tag3[, ...]]] * / ) Add tag(s) to the current chat session. Note : all tags will automatically be converted to lowercase. Parameters tag1, tag2, ... Tag(s) to be added Example script $zopim(function() { $zopim.livechat.addTags("zopim", "livechatAPI"); }); /script sendVisitorPath function sendVisitorPath( options ) Programmatically update visitor’s webpath. Note : Chat triggers set to run When a visitor has loaded the chat widget” will be fired when the visitor path is changed. Parameters options object Optional - If not specified, the current page’s location and title will be used; if specified, the updated page url and title will be taken from the options object. Example Update visitor’s path with specific page url and title: script $zopim(function() { // update visitor’s path with specific page url and title $zopim.livechat.sendVisitorPath({ url: ’http://example.com’, title: ’example’ }); }); /script Update visitor’s path with current page’s location and title: script $zopim(function() { // update visitor’s path with current page’s location and title $zopim.livechat.sendVisitorPath(); }); /script removeTags function removeTags( /* tag1[, tag2[, tag3[, ...]]] * / ) Remove tag(s) from the current chat session. Parameters tag1, tag2, ... Tag(s) to be removed Example script $zopim(function() { $zopim.livechat.removeTags("zopim", "livechatAPI"); }); /script setDisableSound function setDisableSound( bool ) Configure whether sound notifications are played. Parameters bool true to disable sound notifications, false to enable sound notifications (boolean) Example Select: a href="javascript:void($zopim.livechat.setDisableSound(true))"Disable sound/a a href="javascript:void($zopim.livechat.setDisableSound(false))"Enable sound/a setDisableGoogleAnalytics function setDisableGoogleAnalytics( bool ) Configure whether events should be sent to Google Analytics. Parameters bool true to disable Google Analytics events, false to enable Google Analytics events (boolean) Example Select: a href="javascript:void($zopim.livechat.setDisableGoogleAnalytics(true))"Disable Google Analytics events/a a href="javascript:void($zopim.livechat.setDisableGoogleAnalytics(false))"Enable Google Analytics events/a setLanguage function setLanguage( lang ) Set the widget language. Parameters lang Language code (string). Visit https://chat.zendesk.com /hc /en-us /articles /218953857 for a list of supported languages. Example Pick a language: a href="javascript:void($zopim.livechat.setLanguage(’en’))"English/a a href="javascript:void($zopim.livechat.setLanguage(’pt’))"Portuguese/a a href="javascript:void($zopim.livechat.setLanguage(’sv’))"Swedish/a a href="javascript:void($zopim.livechat.setLanguage(’zh_CN’))"Simplified...