Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Roles

Live Chat roles are collections of rights that provide access to the features and functionality within Live Chat. There are system roles and user-defined roles. System roles come with preset rights that are required for users to perform common job roles within the app. User-defined roles are for when you need to grant a unique set of rights to a user.

Before you begin

Note

Assigning a role with a privilege level of user or higher to a user can automatically allocate a Live Chat subscription license to that user.

Role Description
Chat Session Admin Role is a system role primarily used for Elevation purposes we do not recommend assigning this role to any User. (Full Rights)
Chat Session Agent Role should be assigned to any Agent who will be interacting with chat sessions (Rights to Create , Accept, Update, Close)
Chat Session Manager Role should be assigned to any Agent who will be managing Chat Agents (Rights to Create, Accept, Update, Close, Delete).
Portal Chat Session User Role should be assigned to the Customer Portal account to enable use in the Customer Portal or to individual Basic / Full Users to enable access in the service portal. (Rights to Create and Update their own as well as close)
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document