How To Deploy

Easy to use developer API for Chime

If you still have questions, contact

Connecting To The Web Client

The web client is accessed by opening a browser window to the url for the webClient.html file, with parameters for the queue to hit, and optionally the user connecting to the chat.

The URL for the web client might look something like:

The userName parameter should be the XMPP ID for the dispatcher account for the queue to contact. If there are spaces in the XMPP ID, those spaces should be encoded with the characters:%20.

Connecting with a user XMPP ID

If a user is authenticated into an internal page and you have access to their XMPP ID, it is possible to connect with a queue using their XMPP ID by passing an additional parameter stid to the web client URL.

The full URL might look something like:

If hashedUsernames is set to true, you will need to Base64 encode the name before passing it to the URL.

Encoding the Seeker username

The web client uses native JavaScript to Base64 encode and decode the username.

var seekerUsername = "James T. Kirk";
seekerUsername = window.btoa(seekerUsername);

Opening the web client using JavaScript

To open the web client, first we need to know a few values.

clientAddress The URL where the web client is hosted
queue The XMPP ID of the dispatcher for the queue
seekerUsername (optional) The plain text or Base64 encoded XMPP ID for the user accessing the web client

Here is an example on how you might open a chat session with a queue. This example assumes you have jQuery on your page.

<a href="#" class="start-chat">Chat now!</a>

<script type="text/javascript">
    var clientAddress = "//";
    var queue = "Helpdesk%20Support";
    var seekerUsername = "James T. Kirk";
    seekerUsername = btoa(seekerUsername);

    $(".start-chat").on("click", function(){ + "?userName=" + queue + "&stid=" + seekerUsername, "_blank");

Note - For more Web Client API » Web Client API

Note - For a PDF of Advanced API » strong>Advanced Chime API