# 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:

<script src="https://cdn.aihelp.net/webchatv4/aihelp.js"></script>
<body>
  <script>
    (function () {
      let initConfig = {
        appKey: "THIS IS YOUR APP KEY",
        domain: "THIS IS YOUR APP DOMAIN",
        appId: "THIS IS YOUR APP ID",
        entranceId: 'THIS IS YOUR ENTRANCE ID'  
      };
      AIHelpSupport.init(initConfig);
      AIHelpSupport.show();
    })();
  </script>
</body>

Or, you could make your own configuration about AIHelp via the apiConfig property like this:

<script src="https://cdn.aihelp.net/webchatv4/aihelp.js"></script>
<body>
  <script>
    (function () {
      let initConfig = {
        appKey: "THIS IS YOUR APP KEY",
        domain: "THIS IS YOUR APP DOMAIN",
        appId: "THIS IS YOUR APP ID",
        apiConfig: {
          entranceId: 'THIS IS YOUR ENTRANCE ID', 
          welcomeMessage: 'THIS IS YOUR SPECIAL WELCOME MESSAGE',
        }  
      };
      AIHelpSupport.init(initConfig);
      AIHelpSupport.show();
    })();
  </script>
</body>

# URL

Or, you could implement the same function by the URL scheme:

<script>
  let appKey = "THIS IS YOUR APP KEY";
  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}/webchatv4/#/appKey/${appKey}/domain/${domain}/appId/${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 API

Type: object
Default: {}
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.

Entrance Configuration

HelpCenter Configuration

# welcomeMessage

Type: string
Default: ''
Detail: Optional. Custom welcome message for customer service

# Page example

Page examples based on the above scenario are as follows:

← Customer Service Update Language →