REST API Overview

The LibraryH3lp REST API allows you to query metadata associated with your account, including chats, operators, queues, gateways, services, and widgets. You can also do some fancy things like determine the availability of queues and operators for chat, transfer guests between operators and queues, send files to guests, and e-mail transcripts. If you are interested in the underlying mechanics of chat, you'll want to look at the XMPP section.

Since the API is based on REST principles, it's very easy to write and test your own chat applications leveraging all of LibraryH3lp's bells and whistles. Plus you can use your browser to access URLs, and use pretty much any HTTP client in any programming language to interact with our live chat API.

We have LibraryH3lp SDKs available for our REST API:

Base URI

All URLs referenced in the documentation have the following base, which is dependent on whether http or https is used:

[http | https]://us.libraryh3lp.com

LibraryH3lp clients using a regional server, should replace "us" in the URL above with one of "ca", "eu", or "sg".

HTTP and HTTPS

The LibraryH3lp REST API is served almost exclusively over HTTPS. The single exception is presence; though you may use HTTPS there if you wish. For all other resources and to ensure data privacy, unencrypted HTTP is not supported.