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

客户信息变更事件对接

客户信息变更和客户标签变更时,七鱼向企业侧接口推送事件的配置、鉴权、字段和响应约定。

客户信息变更事件

当七鱼系统使用者主动修改访客名片,或访客访问行为触发系统自动修改访客名片时,七鱼会向企业配置的接口推送客户信息变更事件。企业可据此同步更新自有系统中的客户资料。

配置入口

请在七鱼管理后台「系统 > 扩展与集成 > 访客名片接口 URL」处填写企业提供的事件接收地址。

请求方式

七鱼以 POST 方式调用企业配置的接收地址。请求参数主要分为 query 鉴权参数和请求体中的访客名片对象。

Query 参数

接口鉴权参考 通用说明 - 数据校验。

参数参数说明
checksumSHA1(appSecret + md5 + time),将三个参数拼接后进行 SHA1 哈希计算,并转化成小写 16 进制字符串
time当前 UTC 时间戳,从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数

Body 字段

请求体为 JSON 格式的访客名片对象。

字段数据类型说明
nameString名字
phoneString电话
addressInteger地址
vipLevelStringVIP 等级
foreign_idString外部 ID
remarksString备注
first_contact_timeLong首次联系时间
last_contact_timeLong最后联系时间
first_session_timeLong首次会话时间
last_session_timeLong上次会话时间
customFieldMap<Long, Object>自定义属性值 ID
tagsDetailMap<Long, String>标签 ID 和标签名称

客户标签变更事件

当客服在七鱼系统中修改访客标签时,七鱼会回调企业配置的客户标签接口 URL,将标签修改信息同步给第三方系统。

配置入口

请在七鱼管理后台「系统 > 扩展与集成 > CRM 信息对接 > 客户标签接口 URL」处填写企业提供的事件接收地址。

接口请求地址

POST https://xxx.com/xxx/xxx?appKey=1064deea1c3624c9ee26d1de5ce8481f&time=1463217187&checksum=2f13932c4b7c6888b12360a85261a11b8b543f64
Content-Type:application/json;charset=utf-8

Query 参数

参数数据类型是否必须参数说明
appKeyString是企业 appKey
timeInteger是当前 UTC 时间戳,从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数
checksumString是SHA1(appSecret + md5 + time),三个参数拼接后进行 SHA1 哈希计算,并转化成小写 16 进制字符串

Body 字段

参数数据类型参数说明
foreignidString访客的 foreignid
useridLong访客在七鱼的 ID
tag_idsJson标签 ID 数组,标签 ID 可通过客户标签查询接口获取
typeStringsave 表示为用户增加对应标签,delete 表示从用户标签中删除对应标签

响应参数

参数数据类型参数说明
codeInteger错误码。200 表示设置成功
messageString错误提示信息

请求示例

{
  "userid": 12451558,
  "foreignid": "onlyone",
  "tag_ids": [156656, 2455485],
  "type": "save"
}

这篇文档有帮助吗?

目录