1. 配置数据推送地址
请求路径
- 测试环境:bms-test.weiwenjia.com
- 生产环境:bfs.lingxiaodata.com
- https://{host}/api/v1/skb_isvs/update_isv_conf
请求方法
- post
headers
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| Authorization | String | true | { Authorization: Token token=”#{ access-token }” } |
请求Body
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| corp_id | String | true | 企业唯一编码 |
| sync_url | String | true | 批量转移时,推送数据给服务商的地址 |
| single_sync_url | String | false | 单条转移时,推送数据给服务商的地址(未配置时企业详情不显示转移按钮) |
| additional_config_url | String | false | 服务商接收数据的地址配置信息 |
| sign | String | true | 签名,签名算法:sign=md5(corp_id+sync_url+single_sync_url+additional_config_url+secret) |
注:请求是json格式,header中Content-Type: application/json:
请求参数示例:{ "corp_id": "xx", "sync_url": "xxx", "single_sync_url": "xxx", "additional_config_url": "xxxx", "sign": "xxx" }
返回格式:
{
"code": 200,
"message": "成功",
"time_at": "2025-04-16 16:29:25",
}错误码说明
| 错误码(code) | 错误说明 |
|---|---|
| 400 | 参数错误 |
| 404 | 企业不存在 |
| 500 | 系统异常或其他错误,请联系研发人员 |
1. 从第三方获取线索数据配置
请求路径
- 由第三方对接系统配置 获取配置接口地址(可选),skb将调用该接口获取模块配置,转移数据时展示在选择转移模块筛选中,选择之后,skb在转移时会将选择的功能模块数据一起转移
- 配置 获取配置接口地址,见 企业对接接口 中 设置数据同步推送地址- additional_config_url
请求方法
- GET
headers
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access-token | String | true | access-token |
请求参数
| 参数名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| oid | long | true | 必填,Long类型,skb企业id(第三方需要将自己用户与skb oid+uid 绑定,根据 oid+uid 确定获取第三方的哪个用户的配置信息) |
| uid | long | true | 必填,Long类型,skb用户id(第三方需要将自己用户与skb oid+uid 绑定,根据 oid+uid 确定获取第三方的哪个用户的配置信息) |
请求例子:${config_url}?oid=126458222222&uid=4445554777
返回格式
- 接口必须响应200状态码
- 接口必须在5秒内响应
返回格式示例{ "error_code": 0, // error_code必须为0,否则表示当前请求错误 "data": { //转移选项-功能模块配置 "options": [ { "name": "线索池, // 一级功能名称,必须有 "sub": [ // 二级功能模块配置组 { "name": "线索池1", //二级功能模块名称,如果有二级,则必须有 "additional_params": { // 功能模块额外参数,可选 "key": 111 // 额外自定义参数,key } }, { "name": "线索池2" } ], "additional_params": { // 功能模块额外参数,可选 "code": "11", // 额外自定义参数,code "desc": 户管理模块" // 额外自定义参数,desc } }, { "name": "客户公海" } ] } }
返回结构说明
目前只规定需要返回转移选项-功能模块配置的信息,功能模块信息以数组方式在options字段中返回
功能模块结构:
- name:功能模块名称,必须要,转移数据-选择转移功能模块中展示
- additional_params:额外的参数,可选,支持传递这个功能模块的其他参数,例如code,desc等
注意事项
1、选择对应功能模块进行转移时,会将选中功能模块的name和additional_params完整的传递过去;只会传递当前功能模块的信息,子功能模块数据不会一起传递
2、一级功能模块如果包含子功能模块,则需要将子功能模块配置数组存放在一级功能模块的sub字段中
3、每个层级的功能模块最多支持20个,即一级功能模块20个,每个一级功能模块下的sub数组能支持20个二级功能模块数据;大于20个则会截取前20个进行展示筛选
2. 批量转移-推送线索数据到第三方
功能示例:
请求路径
- 由第三方对接系统配置 批量转移推送接口地址,skb将调用该接口将线索数据推送到第三方
- 配置 批量转移推送接口地址,见 企业对接接口 中 设置数据同步推送地址- sync_url
请求方法
- post
headers
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access-token | String | true | access-token |
请求参数:
body参数,JSON示例
{
"sign": "xxxx", // 必填,签名,签名算法:sign=md5(taskId+oid+uid+secret)
"taskId": 1111, // 必填,Long类型,skb任务id(回调任务结果时需要用到)
"async": 1, // 是否异步: 0-同步, 1-异步;批量数据转移时,固定传1-异步,第三方需要通过回调接口来推送转移的结果;单条数据转移时,会传0-同步,第三方需要在在该接口的响应中即时返回转移结果
"oid": 1111, // 必填,Long类型,skb企业id(第三方需要将自己用户与skb oid+uid 绑定,根据 oid+uid 确定数据由第三方的哪个用户转的)
"uid": 2222, // 必填,Long类型,skb用户id(第三方需要将自己用户与skb oid+uid 绑定,根据 oid+uid 确定数据由第三方的哪个用户转的)
"batchId": "387cf029d31ef28836486", // 数据批次id(回调任务结果时需要用到)(当一个任务所有批次数据都推送完成,会进行一次batchId="0"的调用,不传递线索数据,仅做为任务结束通知;第三方也无需回调)
"clueType": "COMPANY", // 线索类型(COMPANY: 工商企业;IMP_EXP_TRADE_COMPAN:海关进口出企业;ONLINE_SHOP: 网店;)(跨境版的套餐,支持转移海关进口出企业、电商平台网店)
"syncTaskOption": { // 同步任务选项-选中的转移功能模块信息
"name": "客户管理", //转移功能模块名称
"additionalParams": { //转移功能模块额外参数,从功能模块配置中获取到的数据
"code": 111, // 额外自定义参数,code
"desc": "管理客户信息" // 额外自定义参数,desc
}
},
"clueItems": [ // 线索数据
{ // 工商企业线索-数据样例
"id": "f3c7933261570af39adb4e66514a019e", // skb线索数据唯一id
"name": "华为技术有限公司", // 企业名称
"contactItems": [ // 联系方式信息
{
"content": "13868787644", // 联系号码
"type": 1, // 联系方式类型, 1:手机;2:固话;3:QQ;4:邮箱
"contactName": "华**", // 联系人姓名
"contactPosition": "市场营销部-员工", // 联系人职位
"contactDepartment": "市场营销部", // 联系人部门
"numStatus": "1", // 号码状态(1:实号 2:异常 3:未知 5:疑似代理)
"labels": [
"推荐",
"近期收录",
"疑似代理"
], // 联系方式标签
"sourceNames": [
"钉钉企典",
"英才网"
] // 来源站点名
}
],
"uncid": "914403001922038216", // 统一社会信用码
"esDate": 558633600000, // 成立时间(时间戳,毫秒)
"legalPerson": "张三", // 法定代表人/负责人
"regCapDisplay": "1000万元人民币", // 注册资本显示值(带单位)
"regAddress": "深圳市龙岗区坂田华为总部办公楼", // 注册地址(完整地址)
"regAddressProvince": "广东省", // 注册地址-省
"regAddressCity": "深圳市", // 注册地址-市
"regAddressDistrict": "龙岗区", // 注册地址-区
"historyNames": [ // 曾用名(历史名称)
"深圳市华为技术有限公司"
],
"hasATax": true, // 是否是A级纳税人
"contactAddress": "深圳市龙岗区坂田华为总部办公楼", // 通讯地址(完整地址)
"contactAddressProvince": "广东省", // 通讯地址-省
"contactAddressCity": "深圳市", // 通讯地址-市
"contactAddressDistrict": "龙岗区", // 通讯地址-区
"website": "www.huawei.com.cn", // 企业官网
"firstIndustry": "制造业", // 所属行业一级
"secondIndustry": "计算机、通信和其他电子设备制造业", // 所属行业二级
"thirdIndustry": "通信设备制造", // 所属行业三级
"fourthIndustry": "通信系统设备制造", // 所属行业四级
"firstIndustryCode": "C", // 所属行业一级code
"secondIndustryCode": "39", // 所属行业二级code
"thirdIndustryCode": "392", // 所属行业三级code
"fourthIndustryCode": "3921", // 所属行业四级code
"opScope": "程控交换机、传输设备、数据通信设备、宽带多媒体设备、电源、无线通信设备...", // 经营范围
"entProfile": "华为创立于1987年,是全球领先的ICT(信息与通信)基础设施和智能终端提供商,我们致力于..." // 企业简介
},
{ // 搜电商平台-网店线索-数据样例
"id": "70db8286de8f03c9883ee617bb411195", // skb线索数据唯一id
"name": "温州市兴之昌汽车部件有限公司", // 网店名称
"contactItems": [ // 联系方式信息
{
"content": "13868787644", // 联系号码
"type": 1, // 联系方式类型, 1:手机;2:固话;3:QQ;4:邮箱
"contactName": "华**", // 联系人姓名
"contactPosition": "市场营销部-员工", // 联系人职位
"contactDepartment": "市场营销部", // 联系人部门
"numStatus": "1", // 号码状态(1:实号 2:异常 3:未知 5:疑似代理)
"labels": [
"推荐",
"近期收录",
"疑似代理"
], // 联系方式标签
"sourceNames": [
"钉钉企典",
"英才网"
] // 来源站点名
}
]
},
{ // 搜海关数据-进口企业/出口企业-数据样例
"id": "fa0650ab387f93a7dcbacf8dc7fe16c5", // skb线索数据唯一id
"name": "XINJI CITY XIANGNONG FRUIT CO.,LTD", // 供应商/采购商名称
"contactItems": [ // 联系方式信息
{
"content": "13868787644", // 联系号码
"type": 1, // 联系方式类型, 1:手机;2:固话;3:QQ;4:邮箱
"contactName": "华**", // 联系人姓名
"contactPosition": "市场营销部-员工", // 联系人职位
"contactDepartment": "市场营销部", // 联系人部门
"numStatus": "1", // 号码状态(1:实号 2:异常 3:未知 5:疑似代理)
"labels": [
"推荐",
"近期收录",
"疑似代理"
], // 联系方式标签
"sourceNames": [
"钉钉企典",
"英才网"
] // 来源站点名
}
],
"totalTransactions": 337, // 交易方信息-交易总次数
"totalAmount": "13332827.4391", // 交易方信息-交易总金额
"recentTransactionDate": 1777478400000, // 最近交易时间(毫秒时间戳)
// 下面的字段是当这个采购商/供应商有关联的工商企业时,其关联工商企业的信息字段
"relatedEntPid": "fa0650ab387f93a7dcbacf8dc7fe16c5", // 关联工商企业的数据id
"relatedEntName": "辛集市乡浓果品有限公司", // 关联工商企业的企业名
"uncid": "9113018105942393XP",
"esDate": 1355760000000,
"legalPerson": "温运田",
"regCapDisplay": "100万人民币",
"regAddress": "辛集市田家庄乡旧寨村村西(村委会西行200米路南)",
"regAddressProvince": "河北",
"regAddressCity": "石家庄",
"regAddressDistrict": "辛集市",
"historyNames": [],
"hasATax": true,
"contactAddress": "辛集市田家庄乡旧寨村村西(村委会西行200米路南)",
"contactAddressProvince": "河北",
"contactAddressCity": "石家庄",
"contactAddressDistrict": "辛集市",
"website": "www.xiangnongfruit.com",
"firstIndustry": "批发和零售业", // 所属行业一级
"secondIndustry": "批发业", // 所属行业二级
"thirdIndustry": "食品、饮料及烟草制品批发", // 所属行业三级
"fourthIndustry": "果品、蔬菜批发", // 所属行业四级
"firstIndustryCode": "F", // 所属行业一级code
"secondIndustryCode": "51", // 所属行业二级code
"thirdIndustryCode": "512", // 所属行业三级code
"fourthIndustryCode": "5123", // 所属行业四级code
"opScope": "一般项目:水果种植;蔬菜种植;初级农产品收购...",
"entProfile": "辛集市乡浓果品有限公司位于美丽的鸭梨之乡河北..."
}
]
}返回格式:
- 接口必须响应200状态码,否则该批数据会视作转移失败
- 接口必须在5秒内响应(如业务逻辑处理不完建议先将推送数据放到队列),否则该批数据会视作转移失败
返回格式示例:
{
"error_code": 0, // 错误码,需固定返回0,否则该批数据会视作转移失败
"message": "" // 响应消息
}3. 单条转移-推送线索数据到第三方
功能示例:
请求路径
- 由第三方对接系统配置 单条转移推送接口地址,skb将调用该接口将线索数据推送到第三方
- 配置 单条转移推送接口地址,见 企业对接接口 中 设置数据同步推送地址- single_sync_url
请求方法
- post
headers
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access-token | String | true | access-token |
请求参数:
body参数,JSON示例
{
"sign": "xxxx", // 必填,签名,签名算法:sign=md5(entityId+oid+uid+secret)。entityId为线索数据id: clueItems[0].id
"async": 0, // 是否异步: 0-同步, 1-异步;单条数据转移时,固定传0-同步,第三方需要在在该接口的响应中即时返回转移结果
"oid": 1111, // 必填,Long类型,skb企业id(第三方需要将自己用户与skb oid+uid 绑定,根据 oid+uid 确定数据由第三方的哪个用户转的)
"uid": 2222, // 必填,Long类型,skb用户id(第三方需要将自己用户与skb oid+uid 绑定,根据 oid+uid 确定数据由第三方的哪个用户转的)
"clueType": "COMPANY", // 线索类型(COMPANY: 工商企业;(当前仅支持工商企业类型))
"syncTaskOption": { // 同步任务选项-选中的转移功能模块信息(数据结构同批量转移)
...
},
"clueItems": [ // 线索数据(数据结构同批量转移)
{
...
}
]
}返回格式:
- 接口必须响应200状态码,否则该批数据会视作转移失败
- 接口必须在30秒内响应,否则会视作转移失败
返回格式示例:
{
"error_code": 0, // 错误码,需固定返回0,否则会视作接口调用异常
"data": {
"success": true, // 必填,线索是否同步成功(如果线索同步失败,则其对应的所有联系方式都将视作同步失败)
"errorMessage": "线索同步失败", // 可选,同步失败时的错误消息
"successContacts": { // 可选,同步成功的联系方式信息,key为号码,value为customerId(Long类型,可选,第三方数据id)
"18812345678": 0
},
"failedContacts": { // 可选,同步失败的联系方式信息,key为号码,value为错误消息提醒
"18812345679": "号码同步失败"
}
},
"message": "" //响应消息
}4. 第三方接收数据处理完成后回调skb
请求路径
- https://{host}/api_skb/v1/isys/sync_task/callback
测试环境:https://skb-test.weiwenjia.com
生产环境:https://skb.weiwenjia.com
请求方法
- post
headers
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access-token | String | true | access-token |
请求参数:
-第三方处理完接收的线索数据后,需按批次调用该接口,告知skb推送数据的处理结果
body参数,JSON示例
{
"sign": "xxxx", // 必填,签名,签名算法:sign=md5(taskId+oid+uid+secret)
"taskId": 1111, // 必填,Long类型,skb任务id
"oid": 1111, // 必填,Long类型,skb企业id
"uid": 2222, // 必填,Long类型,skb用户id
"batchId": "387cf029d31ef28836486", // 必填,数据批次id
"syncResult": { // 必填,线索同步结果,key为skb数据唯一id,value为线索同步结果
"387cf029d31ef28836486d0d38821d5e": {
"success": true, // 必填,线索是否同步成功(如果线索同步失败,则其对应的所有联系方式都将视作同步失败)
"errorMessage": "线索同步失败", // 可选,同步失败时的错误消息
"successContacts": { // 可选,同步成功的联系方式信息,key为号码,value为customerId(Long类型,可选,第三方数据id)
"18812345678": 0
},
"failedContacts": { // 可选,同步失败的联系方式信息,key为号码,value为错误消息提醒
"18812345679": "号码同步失败"
}
}
}
}返回的 联系方式错误消息提醒 的说明:
以"号码重复" 开头的,能对应任务详情-号码列表里的“号码重复”筛选项
以"电话号码格式不正确" 开头的,能对应任务详情-号码列表里的“格式不正确”筛选项
其他返回的消息提醒,都会对应任务详情-号码列表里的“其他”筛选项返回格式:
{
"error_code": 0, // 错误码(0: 回调接收成功)
"message": "参数错误" // 错误消息
}5. 线索转移状态变更为未转移
skb数据推送给第三方后,如果响应同步成功,skb会标记数据为已转移
支持第三方调用该接口,将转移状态变更为未转移(如:数据在第三方系统删除了)
请求路径
- https://{host}/api_skb/v1/isys/clues/modify_non_synced
测试环境:https://skb-test.weiwenjia.com
生产环境:https://skb.weiwenjia.com
请求方法
- put
headers
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access-token | String | true | access-token |
请求参数:
body参数,JSON示例
{
"sign": "xxxx", // 必填,签名,签名算法:sign=md5(oid+secret)
"oid": 1111, // 必填,Long类型,skb企业id
"params": [ // 必填,且不能为null或空数组
{
"clueType": "COMPANY", // 线索类型(COMPANY: 工商企业;(当前仅支持工商企业类型))
"entityIds": [ // skb线索数据唯一id(一批次最多支持传200个)
"f3c7933261570af39adb4e66514a019e"
]
}
]
}返回格式:
{
"error_code": 0, // 错误码(0: 回调接收成功)
"message": "参数错误" // 错误消息
}6. 线索转移状态变更为已转移
支持第三方调用该接口,将转移状态变更为已转移
请求路径
- https://{host}/api_skb/v1/isys/clues/modify_synced
测试环境:https://skb-test.weiwenjia.com
生产环境:https://skb.weiwenjia.com
请求方法
- put
headers
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access-token | String | true | access-token |
请求参数:
body参数,JSON示例
{
"oid": 10010036, // 必填,Long类型,skb企业id
"uid": 9146042, // 选填,Long类型,skb用户id(未填uid的情况下,会默认设置uid为0,额度的扣减会算到uid=0上)
"sign": "xxxx", // 必填,签名,签名算法:sign=md5(oid+secret)
"sourceType": "company", // 必填,线索类型(company: 工商企业;(当前仅支持工商企业类型))
"pids": [ // 必填,skb线索数据唯一id(不能为空,且一批次最多支持传200个)
"pid11"
],
"enableAutoDeduct": false // 选填,是否支持自动扣点(默认是false,默认仅支持的对已查看(已解锁)的数据标记为已转,当enableAutoDeduct=true,会自动消耗用户的额度,先对数据进行解锁,再标记为已转)
}返回格式:
{
"error_code": 0, // 错误码(0: 回调接收成功)
"message": "参数错误", // 错误消息
"data": {
"updatedEntityIds": [ // 成功标记为已转的线索数据id
"pid11"
],
"unViewedEntityIds": [ // 未解锁的线索数据id
"pid22"
],
"deductedQuota": 10 // 本次扣点数
}
}