Want to build your own knowledgebase?
Each LibraryH3lp subscription includes unlimited independent internal or public-facing knowledgebases (FAQs).



Search the LibraryH3lp Knowledge Base

 

 


Does the chat box have a direct URL?

535 views   |   Last updated on Feb 14, 2017    API chat widget

 

Yes! Direct URLs take guest to your chat box with a single click and are also very handy for testing. And if your link is likely to be visited by a guest on a smart device (e.g. you tweeted it), then users on mobile devices will automatically receive the mobile-optimized widget.

Bare URL (default chat box styling)

The example URLs below are for those with subscriptions (or trials) on the United States server.  If you are using another regional server, you'll need to make two adjustments:

  1. Adjust the base URL to reflect the regional server
  2. Adjust the XMPP/Jabber ID to reflect the regional server 

So for example if your subscription is on the Canada regional server, the base URL is https://ca.libraryh3lp.com and the XMPP/Jabber IDs look like either queue-name@chat.ca.libraryh3lp.com or user-name@ca.libraryh3lp.com.

 

Mobile chat box attached to a queue on the US server:

https://libraryh3lp.com/mobile/queue-name@chat.libraryh3lp.com

 

Regular chat box attached to a queue on the US server:

    https://libraryh3lp.com/chat/queue-name@chat.libraryh3lp.com

 

Mobile chat box attached to a user* on the US server:

    https://libraryh3lp.com/mobile/user-name@libraryh3lp.com

 

Regular chat box attached to a user* on the US server:

    https://libraryh3lp.com/chat/username@libraryh3lp.com

 

*Note: Chats sent specific users (and not over a queue) are treated as private conversations and are not logged, so they will not show up in Activity or Reports. They also can't be transferred. To provide logging and transfer capabilities for an individual, create a queue and assign only that one user to it.

 

Adding a Skin to the URL

The URL examples above connect guests with either a queue or user but come with our default chat box styling.  If you want to customize the appearance of the chat box, you'll need to add a skin.  You can create and manage skins within the Widgets page of the admin dashboard. There you can add a title, change colors, customize your identity, provide custom CSS, turn sound on by default, etc... Once you have your skin ready use the skin widget argument and provide your skin's ID number:

 

https://libraryh3lp.com/chat/queue-name@chat.libraryh3lp.com?skin=123456

 

Other URL Customizations

You can override some skin settings if needed in your URL. In the following example, a chat box title of "Ask Us" is provided, and sound is turned on by default:

 

https://libraryh3lp.com/chat/queue-name@chat.libraryh3lp.com?skin=123456&title=Ask+Us&sounds=true

 

Here is a complete list of arguments you can use in the direct URL:

  • identity: identity of operator as seen by guests in the chat box
  • theme: presence icon theme (Email us if you would like to contribute a new or localized theme.)
  • css: Accepts a path to a CSS file you provide on your own server.
  • title: Sets the chat box title. Create spaces between words by using +. Example: Ask+Us.
  • sounds: Sets the default set of chat box alert sound. If it is not specified, sound is off. Turn sound on by default by setting sounds to true.
  • skin: Refers to a skin ID from within the Widgets page of the admin dashboard.
  • lang: Override the user's language browser setting and force the widget to display in the language of your choice. Requires that we have a localization for the specified language.
  • profile: Show chat operators the profile (metadata) for the stated queue, overriding the default (the queue to which the chat was actually sent).

 

Add a title and pick a new theme

https://libraryh3lp.com/chat/queue-name@chat.libraryh3lp.com?title=My+Chat+Widget&theme=gota

 

CSS Hooks

The keyword to supply your own CSS is "css" and the argument should be a URL pointing to your file. Your customizations override the default, so that you can leverage what's already provided without having to reinvent the wheel. An example:

https://libraryh3lp.com/chat/queue-name@chat.libraryh3lp.com?css=https://my.library.edu/chat/custom.css

 

Title and CSS

https://libraryh3lp.com/chat/queue-name@chat.libraryh3lp.com?title=My+Chat+Widget&css=https://my.library.edu/chat/custom.css

 

Topics