function getName()

Get the name of the visitor.

Example

<script>

  $zopim(function() {
    alert("Visitor's name: " + $zopim.livechat.getName());
  });

</script>

function getEmail()

Get the email address of the visitor.

Example

<script>

  $zopim(function() {
    alert("Visitor's email: " + $zopim.livechat.getEmail());
  });

</script>

function getPhone()

Get the phone number of the visitor.

Example

<script>

  $zopim(function() {
    alert("Visitor's phone: " + $zopim.livechat.getPhone());
  });

</script>

function isChatting()

Check whether a chat session is in progress.

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

Example

<script>

  $zopim(function() {
    $zopim.livechat.set({
      language: 'en',
      name: 'Visitor',
      email: 'visitor@site.com'
    });
  });

</script>

function setName( name )

Set the visitor’s name.

Note: This API will not work if the visitor is authenticated.

Parameters

function setEmail( email )

Set the visitor’s email address.

Note: This API will not work if the visitor is authenticated.

Parameters

function setPhone( phone )

Set the visitor’s phone number.

Parameters

function addTags( /*  tag1[, tag2[, tag3[, ...]]]  * / )

Add tag(s) to the current chat session.

Note: all tags will automatically be converted to lowercase.

Parameters

Example

<script>

  $zopim(function() {
    $zopim.livechat.addTags("zopim", "livechatAPI");
  });

</script>

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

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>

function removeTags( /*  tag1[, tag2[, tag3[, ...]]]  * / )

Remove tag(s) from the current chat session.

Parameters

Example

<script>

  $zopim(function() {
    $zopim.livechat.removeTags("zopim", "livechatAPI");
  });

</script>

function setDisableSound( bool )

Configure whether sound notifications are played.

Parameters

Example

Select:
<a href="javascript:void($zopim.livechat.setDisableSound(true))">Disable sound</a>
<a href="javascript:void($zopim.livechat.setDisableSound(false))">Enable sound</a>

function setDisableGoogleAnalytics( bool )

Configure whether events should be sent to Google Analytics.

Parameters

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>

function setLanguage( lang )

Set the widget language.

Parameters

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 Chinese</a>
<a href="javascript:void($zopim.livechat.setLanguage('zh_TW'))">Traditional Chinese</a>

function setGreetings( hash )

Set the greeting messages displayed on the chat button for each status on the desktop widget.

Status can be “online” or “offline”.

Parameters

Compatibility

For backward compatibility, the format { <status> : [ <greeting>, <greeting> ] } is also allowed but only the first greeting in the array will be used.

Example

<script>

  $zopim(function() {
    $zopim.livechat.setGreetings({
          'online': 'Chat with us',
          'offline': 'Leave us a message'
      });
  });

</script>

function clearAll()

Clear all visitor data and register as a new visitor.

For authenticated visitors, use this API to log out the visitor.

function hideAll()

Hide the widget completely.

function say( msg )

Make the visitor send a message.  Starts a chat session if one is not already in progress.

Parameters

Example

<a href="javascript:void($zopim.livechat.say('I would like an orange banana!'))">Order orange banana</a>

function setOnConnected( callback )

Register a callback to be fired when the widget successfully connects to the server.

Parameters

function setOnChatStart( callback )

Register a callback to be fired when a chat starts.

Parameters

function setOnChatEnd( callback )

Register a callback to be fired when a chat ends.

A chat only ends when the visitor (and not the agent) ends the chat, or when the visitor has been idle for an extended period of time.

Parameters

function setOnStatus( callback )

Register a callback to be fired when the account status changes.  The callback will also be called once when this function is executed.

Note: The callback will also be called when a department’s status changes.

Parameters

function setOnUnreadMsgs( callback )

Register a callback to be fired when the number of unread messages changes.  The callback will also be called once when this function is executed.

Parameters

function endChat()

End the current chat session.

function setStatus( status )

Set the widget account status.

Parameters

function setNotes( notes )

Set the visitor’s notes.  Visitor notes are visible only on the Dashboard.

Parameters

function appendNotes( notes )

Append to the visitor’s notes.  Visitor notes are visible only on the Dashboard.

Parameters

function authenticate( options )

Authenticates the visitor using JSON Web Tokens.  Visit https://zop.im/chat_visitor_auth_setup for more information.

Use “$zopim.livechat.clearAll()” to log out an authenticated visitor.

Important: This function must be inserted immediately after the Zendesk Chat Script.

Note: API calls to change verified visitor information (e.g., setName) will not work if the visitor is authenticated.

Parameters

Options object

Example

#NORUN
<script>

  $zopim(function() {
    $zopim.livechat.authenticate({
      jwtFn: function(callback) {
        fetch('JWT_TOKEN_ENDPOINT').then(function(res) {
          res.text().then(function(jwt) {
            callback(jwt);
          });
        });
      }
    });
  });

</script>