# Help Center
AIHelp has upgraded the original FAQ to a Help Center.
Now, you can provide FAQs to your end users in a customized style, with improved page layout and API flexibility.
# API
# show
You can set up a help center entrance in AIHelp dashboard, and use the provided entrance ID to access AIHelp' help center module:
AIHelpSupport.show("THIS IS YOUR ENTRANCE ID");
Or, make use of the ApiConfig
to configure a custom welcome message:
let apiConfig = {
entranceId: "THIS IS YOUR ENTRANCE ID",
welcomeMessage: "THIS IS YOUR WELCOME MESSAGE"
}
AIHelpSupport.show(apiConfig);
# URL
Or, you could implement the same function by the URL scheme:
<script>
let domain = "THIS IS YOUR APP DOMAIN";
let appId = "THIS IS YOUR APP ID";
let entranceId = "THIS IS YOUR ENTRANCE ID";
let welcomeMessage = "THIS IS YOUR SPECIAL WELCOME MESSAGE";
(function () {
let baseUrl = `https://${domain}/webchatv5/#/${appId}`;
let params = `entranceId=${entranceId}&welcomeMessage=${welcomeMessage}`;
let url = `${baseUrl}?${params}`;
window.open(url);
})();
</script>
You can choose to display the FAQ list, showcase a specific category, or a particular FAQ. Additionally, you have the ability to control the visibility of the customer service entrance.
For more information, you can explore further details in the AIHelp dashboard, under Settings - App Settings - SDK Customization.
# Definition
# apiConfig
- Type:
object
- Default: Required. The configuration for customer service, which is the encapsulation of entrance id and welcome message.
# entranceId
- Type:
string
- Detail: Optional. Entrance ID configured in AIHelp dashboard.
# welcomeMessage
- Type:
string
- Default:
''
- Detail: Optional. Custom welcome message for customer service
# Page example
Page examples based on the above scenario are as follows: