Kustomer Chat SDKs

The Kustomer Chat SDK is available for Android, iOS, and web

Open the Chat UI

Learn how to open the Kustomer Chat.

To open the default Kustomer Chat UI, call Kustomer.getInstance().open():

import com.kustomer.ui.Kustomer

Kustomer.getInstance().open()

Open the Chat UI with overrides

You can also pass in to the open() API specific parameters for KusWidgetType (the Kustomer Chat widget experience type) to override and customize the default chat widget experience display.

See Introduction to Kustomer Chat 2.0: Chat Widget Experience in the Kustomer Help Center to learn more about the available chat widget experience display settings in Kustomer.

// Opens chat widget based on your settings in Kustomer.
Kustomer.getInstance().open(KusWidgetType.DEFAULT)
  
// Regardless of chat settings in Kustomer, opens chat widget to the Knowledge Base + Live Chat display. 
Kustomer.getInstance().open(KusWidgetType.CHAT_KB)
  
// Regardless of chat settings in Kustomer, opens widget to the Live Chat only display. 
Kustomer.getInstance().open(KusWidgetType.CHAT_ONLY)

// Regardless of chat settings in Kustomer, opens widget to the Knowledge Base only display. 
Kustomer.getInstance().open(KusWidgetType.KB_ONLY)

KusWidgetType parameter options

Parameter option

Description

KusWidgetType.DEFAULT

Open the chat widget with the selected chat widget experience display settings in Kustomer.

KusWidgetType.CHAT_KB

Open the chat widget with the Knowledge Base + Live Chat chat widget experience display regardless of your Chat 2.0 settings in Kustomer.

KusWidgetType.CHAT_ONLY

Open the chat widget with the Live Chat-only chat widget experience display regardless of your Chat 2.0 settings in Kustomer.

KusWidgetType.KB_ONLY

Open the chat widget with the Knowledge Base-only chat widget experience display regardless of your Chat 2.0 settings in Kustomer.

Updated 3 months ago


Open the Chat UI


Learn how to open the Kustomer Chat.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.