# FAQ

FAQ 模块包含了单条 FAQ，FAQ 分类和所有 FAQ 分类，并且支持通过配置以不同的方式跳转到机器人和人工服务。

# API

在调用 init API 时，你可以配置 supportMode 字段为 showAllFAQSections、showFAQSection 或 showSingleFAQ 来打开 FAQ 页面：

<script src="https://cdn.aihelp.net/webchatv3/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",
        supportMode: 'showAllFAQSections'  
      };
      AIHelpSupport.init(initConfig);
      AIHelpSupport.show();
    })();
  </script>
</body>

也可以根据具体的需求，通过 supportConfig 字段对客服系统进行定制化配置：

<script src="https://cdn.aihelp.net/webchatv3/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",
        supportMode: 'showSingleFAQ',
        supportConfig: {
          conversationIntent: 'human', 
          welcomeMessage: 'This is a welcome message for FAQ',
          showConversationMoment: 'always',
          faqId: 'THIS IS YOUR FAQ ID'
        }  
      };
      AIHelpSupport.init(initConfig);
      AIHelpSupport.show();
    })();
  </script>
</body>

# URL

或者，你也可以通过拼接 URL 的方式实现同样的需求：

<script>
  let appKey = "THIS IS YOUR APP KEY";
  let domain = "THIS IS YOUR APP DOMAIN";
  let appId = "THIS IS YOUR APP ID";
  let faqId = "THIS IS YOUR FAQ ID";
  (function () {
    let baseUrl = `https://${domain}/webchatv3/#/appKey/${appKey}/domain/${domain}/appId/${appId}`;
    let params = `supportMode=showSingleFAQ&faqId=${faqId}&showConversationMoment=always&conversationIntent=human`;
    let url = `${baseUrl}?${params}`;
    window.open(url);
  })();
</script>

# 参数释义

# supportMode

类型：showAllFAQSections | showFAQSection | showSingleFAQ
详情：必传参数。 指定要打开的 FAQ 页面：全部 FAQ 分类列表、某个 FAQ 分类或某个 FAQ 问题。

# supportConfig API

类型：object
默认值：{}
详情：可选参数。 仅在 API 方案中生效，用于对客服系统进行自定义配置。

# conversationIntent

类型：bot | human
默认值：bot
详情：可选参数。 客服系统的跳转意图，bot 为机器人客服，human 为人工客服。

# alwaysShowHumanSupportButtonInBotPage

类型：boolean
默认值：false
详情：可选参数。 机器人常显人工入口。

# welcomeMessage

类型：string
默认值：''
详情：可选参数。 人工客服自定义欢迎语，自定义传参。

# storyNode

类型：string
默认值：''
详情：可选参数。 特定故事线的入口节点，故事线配置内容。

# showConversationMoment

类型：always | never | onlyInAnswerPage | afterMarkingHelpful
默认值：never
详情：可选参数。 FAQ 页面展示联系客服按钮的时机：常显、不显、详情页显示、点踩后显示。

# sectionId showFAQSection

类型：string
详情：必传参数。 仅在 supportMode 设置为 showFAQSection 时生效，用于指定要展示的 FAQ 分类的分类 ID。可在 AIHelp 后台图示位置获取：

# faqId showSingleFAQ

类型：string
详情：必传参数。 仅在 supportMode 设置为 showSingleFAQ 时生效，用于指定要展示的特定 FAQ 的 ID，可在 AIHelp 后台图示位置获取：

# 场景假设

让我们来假定一个场景。

一个赛季终于结束了，你在 AIHelp 后台配置了一系列赛季奖励发放相关的问题，然后通过 FAQ 的方式将它们展示在应用首屏，期望解决用户可能会有的疑问。

与此同时，应用针对不同等级的用户有不同的支持、关怀方案，具体如下：

1、等级 < 20 级的用户对 FAQ 点踩以后才可以看到联系客服按钮；

2、20 级 < 等级 < 50 级的用户始终可以在 FAQ 页面右上角看到联系客服按钮，点击后默认联系机器人客服，同时在机器人页面右上角提供直接联系人工客服的入口；

3、等级 > 50 级的用户始终可以在 FAQ 页面看到联系客服按钮，点击后直接为他们联系人工客服，并展示有区别于其他用户的特殊欢迎语。

那么，不同平台针对这个场景的代码实现如下所示：

# API

<script src="https://cdn.aihelp.net/webchatv3/aihelp.js"></script>
<script>
  (function (level) {
    let supportConfig = {};
    if (level < 20) {
      supportConfig["showConversationMoment"] = 'afterMarkingHelpful'; 
    } else if (level < 50) {
      supportConfig["showConversationMoment"] = 'always'; 
      supportConfig["alwaysShowHumanSupportButtonInBotPage"] = true;
    } else {
      supportConfig["showConversationMoment"] = 'always'; 
      supportConfig["conversationIntent"] = 'human'; 
      supportConfig["welcomeMessage"] = "This is a welcome message for FAQ";
    }
    var initConfig = {
      appKey: "THIS IS YOUR APP KEY",
      domain: "THIS IS YOUR APP DOMAIN",
      appId: "THIS IS YOUR APP ID",
      appName: "THIS IS YOUR APP NAME(OPTIONAL)",
      language: "THIS IS YOUR DEFAULT LANGUAGE(OPTIONAL)",
      supportMode: "showAllFAQSections",
      supportConfig: supportConfig,
    };
    AIHelpSupport.init(initConfig);
    AIHelpSupport.show();
  })();
</script>

# URL

<script>
  let appKey = 'THIS IS YOUR APP KEY';
  let domain = 'THIS IS YOUR APP DOMAIN';
  let appId = 'THIS IS YOUR APP ID';
  (function (level) {
    let url = `https://${domain}/webchatv3/#/appKey/${appKey}/domain/${domain}/appId/${appId}?supportMode=showAllFAQSections`;
    if (level < 20) {
      url = `${url}&showConversationMoment=afterMarkingHelpful`;
    } else if (level < 50) {
      url = `${url}&showConversationMoment=always&alwaysShowHumanSupportButtonInBotPage=true`;
    } else {
      url = `${url}&showConversationMoment=always&conversationIntent=human&welcomeMessage=This is a welcome message for FAQ`;
    }
    window.open(url);
  })();
</script>

# 页面示例

基于以上场景的 AIHelp 页面显示示例如下：

← 客服系统运营 →