客户信息变更事件对接
客户信息变更和客户标签变更时,七鱼向企业侧接口推送事件的配置、鉴权、字段和响应约定。
客户信息变更事件
当七鱼系统使用者主动修改访客名片,或访客访问行为触发系统自动修改访客名片时,七鱼会向企业配置的接口推送客户信息变更事件。企业可据此同步更新自有系统中的客户资料。
配置入口
请在七鱼管理后台「系统 > 扩展与集成 > 访客名片接口 URL」处填写企业提供的事件接收地址。
请求方式
七鱼以 POST 方式调用企业配置的接收地址。请求参数主要分为 query 鉴权参数和请求体中的访客名片对象。
Query 参数
接口鉴权参考 通用说明 - 数据校验。
| 参数 | 参数说明 |
|---|---|
| checksum | SHA1(appSecret + md5 + time),将三个参数拼接后进行 SHA1 哈希计算,并转化成小写 16 进制字符串 |
| time | 当前 UTC 时间戳,从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数 |
Body 字段
请求体为 JSON 格式的访客名片对象。
| 字段 | 数据类型 | 说明 |
|---|---|---|
| name | String | 名字 |
| phone | String | 电话 |
| address | Integer | 地址 |
| vipLevel | String | VIP 等级 |
| foreign_id | String | 外部 ID |
| remarks | String | 备注 |
| first_contact_time | Long | 首次联系时间 |
| last_contact_time | Long | 最后联系时间 |
| first_session_time | Long | 首次会话时间 |
| last_session_time | Long | 上次会话时间 |
| customField | Map<Long, Object> | 自定义属性值 ID |
| tagsDetail | Map<Long, String> | 标签 ID 和标签名称 |
客户标签变更事件
当客服在七鱼系统中修改访客标签时,七鱼会回调企业配置的客户标签接口 URL,将标签修改信息同步给第三方系统。
配置入口
请在七鱼管理后台「系统 > 扩展与集成 > CRM 信息对接 > 客户标签接口 URL」处填写企业提供的事件接收地址。
接口请求地址
POST https://xxx.com/xxx/xxx?appKey=1064deea1c3624c9ee26d1de5ce8481f&time=1463217187&checksum=2f13932c4b7c6888b12360a85261a11b8b543f64
Content-Type:application/json;charset=utf-8Query 参数
参考 通用说明 - 数据校验。
| 参数 | 数据类型 | 是否必须 | 参数说明 |
|---|---|---|---|
| appKey | String | 是 | 企业 appKey |
| time | Integer | 是 | 当前 UTC 时间戳,从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数 |
| checksum | String | 是 | SHA1(appSecret + md5 + time),三个参数拼接后进行 SHA1 哈希计算,并转化成小写 16 进制字符串 |
Body 字段
| 参数 | 数据类型 | 参数说明 |
|---|---|---|
| foreignid | String | 访客的 foreignid |
| userid | Long | 访客在七鱼的 ID |
| tag_ids | Json | 标签 ID 数组,标签 ID 可通过客户标签查询接口获取 |
| type | String | save 表示为用户增加对应标签,delete 表示从用户标签中删除对应标签 |
响应参数
| 参数 | 数据类型 | 参数说明 |
|---|---|---|
| code | Integer | 错误码。200 表示设置成功 |
| message | String | 错误提示信息 |
请求示例
{
"userid": 12451558,
"foreignid": "onlyone",
"tag_ids": [156656, 2455485],
"type": "save"
}这篇文档有帮助吗?
CRM 接口对接
CRM 接口的鉴权、用户与订单信息、微信生态及企微群聊对接说明。
客户导入
批量新增、修改或删除客户中心中的客户资料。请求体中 update 和 delete 至少包含一个;单次 update、delete 各最多 1000 条。 新增或更新时,foreignId 与 phone 至少传一个。有 foreignId 时以 foreignId 作为客户资料唯一标识;没有 foreignId 时以 phone 作为唯一标识。同一批次不允许出现重复的 foreignId 或 phone。 删除时,foreignId 与 phone 至少传一个;有 foreignId 时优先按 foreignId 删除,否则按 phone 删除。 客户信息自定义字段导入:在“客户管理-设置-客户信息”中已配置、启用并显示的字段,可以使用字段名称作为属性名传入;未启用字段会被忽略。时间控件字段值必须为毫秒时间戳,数字字段值必须为数字。 客户信息变更事件方向相反:当七鱼系统使用者主动修改访客名片,或访客访问行为触发系统自动修改访客名片时,七鱼会向企业在管理后台配置的“访客名片接口URL”发起 POST 回调。回调 query 参数包含 time、checksum,body 为访客名片对象,字段包括 name、phone、address、vipLevel、foreign_id、remarks、first_contact_time、last_contact_time、first_session_time、last_session_time、customField、tagsDetail。