KustomerCore.getChatSettings()

Returns the chat configuration settings.

๐Ÿ‘

First, initialize chat

You must initialize with KustomerCore.init() before you can execute any additional Core SDK methods

Examples

// get chat settings
const chatSettings = KustomerCore.getChatSettings();

Syntax

returnValue = KustomerCore.getChatSettings();

Parameter

Type

Description

returnValue

Object

Required

An instance of SettingsAttributes

SettingsAttributes

Parameter

Type

Description

enabled

Boolean

If false, completely disables Kustomer. To edit, go to Channels > Chat > Settings > Enable Chat toggle on the Kustomer website.

sharedPubNubKeySet

Object

{
subscribeKey: string,
publishKey: string
}

teamIconUrl

String

The URL where the team icon image can be found.

embedIconUrl

String

The URL where the icon to open the chat widget is found.

teamName

String

The name of the support team to be displayed.

greeting

String

The greeting displayed when the organization is available.

waitMessage

String

Message to show before an agent joins the conversation, at the top of the chat screen. Shown when inside of business hours and not during a holiday. If offlineDisplay == .online, this is also shown outside of business hours/holidays.

singleSessionChat

Boolean

Only allow one active conversation at a time. If true, customer canโ€™t create a new chat if they already have one open.

noHistory

Boolean

When chats are ended, they are not shown in previous conversation history.

offhoursImageUrl

String

Image to display when offline (outside of business hours) on the blank new conversation screen.

offhoursMessage

String

Greeting message to show at top of screen when offline (outside of business hours). Shown when outside of business hours (or during a holiday) and when offhoursDisplay == .offline

offhoursDisplay

String

How to handle chat when outside of business hours. Either act like the organization is online, show it as offline, or hide chat entirely.

closableChat

Boolean

Allow both a User and Customer to end a chat conversation. No further chat messages will be able to be sent in an ended conversation.

showTypingIndicatorCustomerWeb

Boolean

Show if the agent is typing in the mobile sdk.

showTypingIndicatorWeb

Boolean

If we should send typing indicators when the customer is typing on their phone.

domainCriteria

Object

Use KustomerCore.isUrlAllowed() to evaluate a URL against these rules

widgetType

Show chat, kb, or both.

activeAssistant

String

The unique ID of the default conversational assistant used for all new chat conversations.

assistantRules

Array of AssistantRule Instances

Use KustomerCore.GetAssistant() to get the assistant that is active after these rules are evaluated.

colors

Object

See the SettingsColors section below to see the properties of the object.

brandId

String

The Id of the brand that this setting applies to.

knowledgeBaseId

String

The unique ID of the knowledge base.

SettingsColors

Parameter

Type

headerBackground

String

headerPrimaryText

String

headerSecondaryText

String

agentBubbleBackground

String

agentBubblePrimaryText

String

agentBubbleSecondaryText

String

customerBubbleBackground

String

customerBubblePrimaryText

String

primaryButtonBackground

String

primaryButtonBackgroundHover

String

primaryButtonText

String


Did this page help you?