# 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:
ApiConfig apiConfig = ApiConfigBuilder()
.setEntranceId("THIS IS YOUR ENTRANCE ID")
.setWelcomeMessage("THIS IS YOUR WELCOME MESSAGE").build();
AIHelpSupport::show(apiConfig);
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:
ApiConfig
- 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: