七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入

CRM对接

设置用户信息

_$setUserInfo

七鱼 SDK 允许 App 的用户以匿名方式向客服咨询,但如果希望客服知道咨询的用户的身份信息,可以通过插件提供的 _$setUserInfo 接口告诉给客服。 该接口包含两个功能:

  1. 关联用户账户。调用过该方法后,在连接客服时,客服即可知道当前用户是谁,并可以调看该用户之前发生过的访问记录。同时,SDK 还会把 App 端相同用户 ID 的咨询记录整合在一起。如果调用 _$setUserInfo(userInfo) 接口前是匿名状态,那么匿名状态下的聊天记录也会被整合到新设置的这个用户下面。
  2. 提供用户的详细资料。通过设置参数 userInfo 的 data 字段,小程序 能把用户的详细信息告诉给客服,这些信息会显示在客服会话窗口的用户信息栏中。

参数说明

_$setUserInfo(userInfo: UserInfo): Promise<void>

UserInfo

名称类型必填说明
userIdstring否可选,用户在企业产品中的标识,便于后续客服系统中查看该用户在产品中的相关信息,不传表示匿名用户 。若要指定用户信息,不显示默认的(guestxxx用户姓名),就必须传userId
authTokenstring否用户认证,参考用户认证 auth_token 的几种校验规则
dataDataItem[]否可选,用户在企业中的其他详细信息,JSON数据格式

DataItem

名称类型必填说明
keystring是数据项的名称,用于区别不同的数据。其中real_name、mobile_phone、email为保留字段,分别对应客服工作台用户信息中的“姓名”、“手机”、“邮箱”这三项数据。保留关键字对应的数据项中,index、label属性将无效,其显示顺序及名称由网易七鱼系统指定
valueany是该数据显示的值,类型不做限定,根据实际需要进行设定
labelstring是该项数据显示的名称
indexnumber否用于排序,显示数据时数据项按index值升序排列;不设定index的数据项将排在后面;index相同或未设定的数据项将按照其在 JSON 中出现的顺序排列
hrefstring否超链接地址。若指定该值,则该项数据将显示为超链接样式,点击后跳转到其值所指定的 URL 地址
hiddenboolean否仅对非保留字段有效,表示是否隐藏对应的数据项,true为隐藏,false为不隐藏。若不指定,默认为false不隐藏

代码示例

const myPluginInterface = requirePlugin('myPlugin');
const userInfo = {
  userId: 'user9527',
  data: [
    { "key": "real_name", "value": "用户A" },
    { "key": "mobile_phone", "value":"13800000000"},
    { "key": "email", "value": "13800000000@163.com" },
    { "index": 0, "key": "account", "label": "账号", "value": "zhangsan", "href": "http://example.domain/user/zhangsan" },
    { "index": 1, "key": "sex", "label": "性别", "value": "先生" },
    { "index": 2, "key": "reg_date", "label": "注册日期", "value": "2015-01-01" },
    { "index": 3, "key": "last_login", "label": "上次登录时间", "value": "2025-01-01 10:00:00" },
    { "index": 4, "key": "avatar", "label": "头像", "value": "https://ysf.nosdn.127.net/985726b5a8840b84a8a90c6b71642813" }
  ]
}
myPluginInterface._$setUserInfo(userInfo);

设置用户 VIP 等级

_$setVipLevel

七鱼客服增加了设置用户 VIP 等级的功能,便于区分用户等级,允许 VIP 用户优先进线或为 VIP 用户指定专线客服,提升用户体验。

使用该功能需要在七鱼管理系统 -> 设置 -> VIP 客户设置页面打开 VIP 开关,否则设置将不会生效。

参数说明

_$setVipLevel(level: number): Promise<void>
名称类型必填说明
levelnumber否设置用户的VIP等级。
  • 如果为 0,为普通用户;

  • 如果为 1-10,为用户 VIP 等级 1-10 级;

  • 如果为 11,为通用 VIP 用户,即不显示用户等级。

代码示例

const myPluginInterface = requirePlugin('myPlugin');
myPluginInterface._$setVipLevel(8);

这篇文档有帮助吗?

目录