About Kustomer Chat SDKsWeb SDKiOS SDKAndroid SDKReact Native SDK
GuidesRecipesChangelog
About Kustomer Chat SDKsWeb SDKiOS SDKAndroid SDKReact Native SDKLog InSupport Portal
Support Portal

Open the Chat UI

Learn how to open the Kustomer Chat.

Suggest Edits

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 KusPreferredView (the Kustomer Chat widget experience type) to override and customize the default chat widget experience display.

🚧

The KusWidgetType option has been deprecated as of v2.9.8.

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

// Opens widget based on your settings in Kustomer.
Kustomer.getInstance().open(KusPreferredView.DEFAULT)

// Regardless of chat settings in Kustomer, opens widget to the Knowledge Base + Live Chat display, with the Chat tab selected. 
Kustomer.getInstance().open(KusPreferredView.CHAT_HISTORY) 
  
// Regardless of chat settings in Kustomer, opens widget to the Knowledge Base + Live Chat display, with the Knowledge Base tab selected. 
Kustomer.getInstance().open(KusPreferredView.KNOWLEDGE_BASE_HOME)
  
// Regardless of chat settings in Kustomer, opens widget to the Live Chat only display. 
Kustomer.getInstance().open(KusPreferredView.CHAT_ONLY)

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

KusPreferredView parameter options

Parameter optionDescription
KusPreferredView.DEFAULTOpen the chat widget with the selected chat widget experience display settings in Kustomer.
KusPreferredView.CHAT_HISTORYOpen the chat widget with the Knowledge Base + Live Chat chat widget experience display regardless of your Chat settings in Kustomer. The Chat tab is selected.
KusPreferredView.KNOWLEDGE_BASE_HOMEOpen the chat widget with the Knowledge Base + Live Chat chat widget experience display regardless of your Chat settings in Kustomer. The Knowledge Base tab is selected.
KusPreferredView.CHAT_ONLYOpen the chat widget with the Live Chat-only chat widget experience display regardless of your Chat settings in Kustomer.
KusPreferredView.KB_ONLYOpen the chat widget with the Knowledge Base-only chat widget experience display regardless of your Chat settings in Kustomer.

Updated about 2 years ago