Widget SDK

​

Configuration

You can configure the widget during launch by setting the window.chtlConfig object, as shown below.

window.chtlConfig = {
    // Configuration options
};

Below are the available properties you can set.

​

chatIconVisible

Whether to display the chat icon (open and close buttons).

• Possible values: true, false
• Default: true

window.chtlConfig = {
    chatIconVisible: true,
    // ... other config options
};

​

displayType

The type of widget to display.

• Possible values: floating, fullscreen, page_inline
• Default: floating

window.chtlConfig = {
    displayType: 'floating',
    // ... other config options
};

​

language

The language of the widget in ISO 639-1 format. This will override the language set in your chatbot’s appearance settings.

• Possible values: en, ar, az, bg, bn, bs, ca, cs, da, de, el, en, es, et, fa, fi, fr, he, hi, hr, hu, hy, id, it, ja, ko, lt, lv, mn, ms, nl, no, pl, pt, pt-br, ro, ru, sk, sl, sq, sr, sv, th, tr, uk, ur, vi, zh-cn, zh-tw

window.chtlConfig = {
    language: 'en',
    // ... other config options
};

​

Methods

Below are the SDK methods you can call to interact with the widget.

​

open()

Opens the chatbot, similar to when a user clicks the chat icon.

window.Chatling.open();

​

minimize()

Minimizes the chatbot, similar to when a user clicks the minimize button in the widget.

window.Chatling.minimize();

​

hideChatIcon()

Hides the chat icon.

window.Chatling.hideChatIcon();

​

showChatIcon()

Shows the chat icon.

window.Chatling.showChatIcon();

​

setVariables()

You can pass custom values to the chatbot at any point after it’s loaded.

The method takes an object containing the variable names and values. You must make sure that the variables have been created in the builder and that the names match exactly.

window.Chatling.setVariables({
    "contact_name": "Rick Astley",
    "contact_email": "[email protected]",
    "age": 30
}, function(success, errorMessage) {
    if (!success) {
        // handle error
    }
});

​

destroy()

Permanently removes the chatbot from the page.

window.Chatling.destroy();