# FAQ

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

# API

# showAllFAQSections

你可以通过配置来展示分类列表,支持 FAQ 的搜索,并支持在合适的位置展示客服系统入口:

[AIHelpSupportSDK showAllFAQSections];

或者根据需求进行自定义配置:

AIHelpFAQConfigBuilder *faqBuilder = [AIHelpFAQConfigBuilder new];

AIHelpConversationConfigBuilder *builder = [AIHelpConversationConfigBuilder new];
builder.conversationIntent = AIHelpConversationIntentBotSupport;
builder.alwaysShowHumanSupportButtonInBotPage = YES;
builder.welcomeMessage = @"This is a welcome message for FAQ.";

faqBuilder.showConversationMoment = AIHelpFAQShowConversationMomentAlways;
faqBuilder.conversationConfig = builder.build;

[AIHelpSupportSDK showAllFAQSections:faqBuilder.build];

# showFAQSection

不同于展示全部分类列表,AIHelp 支持在某些特殊场景下单独展示某个 FAQ 分类:

[AIHelpSupportSDK showFAQSection:@"SECTION ID"];

或者根据需求进行自定义配置:

AIHelpFAQConfigBuilder *faqBuilder = [AIHelpFAQConfigBuilder new];

AIHelpConversationConfigBuilder *builder = [AIHelpConversationConfigBuilder new];
builder.conversationIntent = AIHelpConversationIntentBotSupport;
builder.alwaysShowHumanSupportButtonInBotPage = YES;
builder.welcomeMessage = @"This is a welcome message for FAQ.";

faqBuilder.showConversationMoment = AIHelpFAQShowConversationMomentOnlyInAnswerPage;
faqBuilder.conversationConfig = builder.build;

[AIHelpSupportSDK showFAQSection:@"SECTION ID" config:faqBuilder.build];

# showSingleFAQ

你可以通过调用此方法来展示某个特定的 FAQ 问题:

[AIHelpSupportSDK showSingleFAQ:@"FAQ ID"];

或者根据需求进行自定义配置:

AIHelpFAQConfigBuilder *faqBuilder = [AIHelpFAQConfigBuilder new];

AIHelpConversationConfigBuilder *builder = [AIHelpConversationConfigBuilder new];
builder.conversationIntent = AIHelpConversationIntentBotSupport;
builder.alwaysShowHumanSupportButtonInBotPage = YES;
builder.welcomeMessage = @"This is a welcome message for FAQ.";

faqBuilder.showConversationMoment = AIHelpFAQShowConversationMomentAfterMarkingUnhelpful;
faqBuilder.conversationConfig = builder.build;

[AIHelpSupportSDK showSingleFAQ:@"FAQ ID" config:faqBuilder.build];

# 参数释义

# faqConfig

  • 类型:AIHelpFAQConfig
  • 默认值:nil
  • 详情:可选参数。 FAQ 模块的定制化配置。

# conversationConfig

  • 类型:AIHelpConversationConfig
  • 默认值:nil
  • 详情:可选参数。 从 FAQ 跳转到客服系统的配置项。

# showConversationMoment

  • 类型:AIHelpFAQShowConversationMoment
  • 默认值:AIHelpFAQShowConversationMomentNever
  • 详情:可选参数。 FAQ 页面展示联系客服按钮的时机,可选值:常显、不显、详情页显示、点踩后显示。

# conversationIntent

  • 类型:AIHelpConversationIntent
  • 默认值:AIHelpConversationIntentBotSupport
  • 详情:可选参数。 客服系统的跳转意图。

# alwaysShowHumanSupportButtonInBotPage

  • 类型:BOOL
  • 默认值:NO
  • 详情:可选参数。 机器人常显人工入口。

# welcomeMessage

  • 类型:NSString
  • 默认值:''
  • 详情:可选参数。 人工客服自定义欢迎语,自定义传参。

# storyNode

  • 类型:NSString
  • 默认值:''
  • 详情:可选参数。 特定故事线的入口节点,故事线配置内容。

# sectionId

  • 类型:NSString
  • 详情:必传参数。 要展示的 FAQ 分类的分类 ID,可在 AIHelp 后台图示位置获取:

# faqId

  • 类型:NSString
  • 详情:必传参数。 要展示的特定 FAQ 的 ID,可在 AIHelp 后台图示位置获取:

# 场景假设

让我们来假定一个场景。

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

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

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

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

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

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

- (void)showAllFAQSections:(int)level {
    AIHelpFAQConfigBuilder *faqBuilder = [[AIHelpFAQConfigBuilder alloc] init];
    AIHelpConversationConfigBuilder *conversationBuilder = [[AIHelpConversationConfigBuilder alloc] init];
    if (level < 20) {
        faqBuilder.showConversationMoment = AIHelpFAQShowConversationMomentAfterMarkingUnhelpful;
    }else if (level < 50) {
        faqBuilder.showConversationMoment = AIHelpFAQShowConversationMomentAlways;
        conversationBuilder.alwaysShowHumanSupportButtonInBotPage = YES;
        faqBuilder.conversationConfig = conversationBuilder.build;
    }else {
        faqBuilder.showConversationMoment = AIHelpFAQShowConversationMomentAlways;
        conversationBuilder.conversationIntent = AIHelpConversationIntentHumanSupport;
        conversationBuilder.welcomeMessage = @"THIS IS YOUR SPECIAL WELCOME MESSAGE";
        faqBuilder.conversationConfig = conversationBuilder.build;
    }
    [AIHelpSupportSDK showAllFAQSections: faqBuilder.build];
}

# 页面示例

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

上次更新: 8/1/2023, 2:02:11 AM