KustomerCore.getKnowledgeBaseConfig()
Returns the KnowledgeBase configuration settings.
First, initialize chatYou must initialize with
KustomerCore.init()before you can execute any additional Core SDK methods
Examples
// get KnowledgeBase configuration
const knowledgeBaseConfig = KustomerCore.getKnowledgeBaseConfig(function (res, error) {
console.log('KnowledgeBase configuration!');
});Syntax
KustomerCore.getKnowledgeBaseConfig(function(callbackResponse, error));| Parameter | Type | Description |
|---|---|---|
| function(callbackResponse, error) | Function | Optional A callback that is run after the completion of this method. callbackResponse is an object returned to the callback function. See the error is either |
callbackResponse
callbackResponse| Parameter | Type | Description |
|---|---|---|
| id | String | The unique ID of the Knowledge Base. |
| articleSurvey | Object | See the ArticleSurvey section below to see the properties of the object. |
| knowledgeBaseDomain | String | The base Url of the Knowledge Base. |
ArticleSurvey
| Parameter | Type | Description |
|---|---|---|
| suggestedReasons | Array of SuggestedReasons | The responses customers can choose from while answering your article survey. The limit is 5. |
| enabled | Boolean | Whether surveys are turned on for your help articles. The default value is false. |
| suggestedReasonsEnabled | Boolean | Whether customers can send feedback through your pre-written responses. The default value is false. |
| writtenFeedbackEnabled | Boolean | Whether customers can provide open-ended feedback for your help articles. The default value is false. |
| ratingTitle | String | The question displayed when article feedback is available. |
| ratingValues | String | The rating for the article. Can be 'positive' or 'negative'. |
| suggestedReasonsTitle | String | The question displayed when suggested reasons are available. |
| writtenFeedbackTitle | String | The question displayed when written feedback is available. |
| submitButtonText | String | The label for the Submit button on your survey. |
| positiveConfirmationMessage | String | The confirmation message customers see when submitting positive feedback. |
| negativeConfirmationMessage | String | The confirmation message customers see when submitting negative feedback. |
Updated 16 days ago