# 用户信息

现在你可以用更简单、更清晰的方式设置、更新用户信息。

注意

请确保调用 API 时同步给 AIHelp 的 userId 是唯一的有效值。

将 userId 设置为诸如空字符串("")、"null"、0 或 -1 等无效值,可能会导致客服功能异常。

# API

# updateUserInfo()

你可以在用户登录时调用此方法来将用户同步给 AIHelp,并通过 customData & userTags 来为你获取到更多的用户信息:

UserConfig userConfig = new UserConfigBuilder()
        .setUserId("123456789")
        .setUserName("AIHelper")
        .setUserTags("recharge,suggestion")
        .build();
AIHelpSupport::updateUserInfo(userConfig);

# resetUserInfo()

用户退出登录时调用此方法告知 AIHelp 来清除登录用户的信息,以保证游客/用户信息的准确性:

AIHelpSupport::resetUserInfo();

# 参数释义

# UserConfig

  • 类型:UserConfig
  • 详情:必传参数。 用户信息配置项,包括用户名、用户唯一 ID、用户标签等

# userId

  • 类型:string
  • 默认值:用户设备随机数
  • 详情:可选参数。 用户唯一标识,不可以设置为空字符串、0 或 -1

# userName

  • 类型:string
  • 默认值:anonymous
  • 详情:可选参数。 用户名称

# serverId

  • 类型:string
  • 默认值:-1
  • 详情:可选参数。 用户所在服务器 ID

# userTags

  • 类型:string
  • 默认值:''
  • 详情:可选参数。 用户标签,多个标签之间需要以「,」分隔。另外,在具体为用户配置标签时,你应该确保已经提前在 AIHelp 后台配置好了对应的标签内容:

# customData

  • 类型:string
  • 默认值:''
  • 详情:可选参数。 自定义用户数据,格式为 jsonString: {"key":"value", "key":"value"}

# 场景假设

让我们来假定一个场景,你希望在 AIHelp 后台统计到用户的某些信息,具体如下:

1、当前用户等级;

2、充值记录;

3、用户存量金币数量;

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

UserConfig userConfig = new UserConfigBuilder()
        .setUserId("123456789")
        .setUserName("AIHelper")
        .setUserTags("recharge,suggestion")
        .build();
AIHelpSupport::updateUserInfo(userConfig);

# 页面示例

配置完成后,当这个用户发起一条客诉时,你就可以在 AIHelp 后台看到如下效果:

上次更新: 11/8/2024, 3:37:27 AM