数据同步对接

1、从第三方获取线索数据配置

请求路径

• 由第三方对接系统配置获取配置接口地址（可选），skb将调用该接口获取模块配置，转移数据时展示在选择转移模块筛选中，选择之后，skb在转移时会将选择的功能模块数据一起转移

请求方法

• GET

headers

请求参数

请求例子：${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将调用该接口将线索数据推送到第三方

请求方法

• post

headers

请求参数:

body参数，JSON示例

{
    "sign": "xxxx", // 必填，签名，签名算法：sign=md5(taskId+oid+uid+secret)
    "taskId": 1111, // 必填，Long类型，skb任务id（回调任务结果时需要用到）
    "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: 工商企业；（当前仅支持工商企业类型））
    "syncTaskOption": { // 同步任务选项-选中的转移功能模块信息
        "name": "客户管理", //转移功能模块名称
        "additionalParams": { //转移功能模块额外参数，从功能模块配置中获取到的数据
            "code": 111, // 额外自定义参数，code
            "desc": "管理客户信息" // 额外自定义参数，desc
        }
    },
    "clueItems": [ // 线索数据
        { // 工商企业线索数据
            "id": "f3c7933261570af39adb4e66514a019e", // skb线索数据唯一id
            "name": "华为技术有限公司", // 企业名称
            "contactItems": [ // 联系方式信息
                {
                    "content": "13868787644", // 联系号码
                    "type": 1, // 联系方式类型
                    "contactName": "华**", // 联系人姓名
                    "contactPosition": "市场营销部-员工", // 联系人职位
                    "contactDepartment": "市场营销部", // 联系人部门
                    "numStatus": "1", // 号码状态
                    "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", // 企业官网
            "opScope": "程控交换机、传输设备、数据通信设备、宽带多媒体设备、电源、无线通信设备...", // 经营范围
            "entProfile": "华为创立于1987年,是全球领先的ICT(信息与通信)基础设施和智能终端提供商,我们致力于..." // 企业简介
        }
    ]
}

返回格式:

• 接口必须响应200状态码，否则该批数据会视作转移失败
• 接口必须在5秒内响应（如业务逻辑处理不完建议先将推送数据放到队列），否则该批数据会视作转移失败

返回格式示例：

{
    "error_code": 0 // 错误码，需固定返回0，否则该批数据会视作转移失败
}

3 第三方接收数据处理完成后回调skb

请求路径

• https://skb.weiwenjia.com/api_skb/v1/isys/sync_task/callback

请求方法

• post

headers

请求参数:

-第三方处理完接收的线索数据后，需按批次调用该接口，告知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": "参数错误" // 错误消息
}

4. 线索转移状态变更为未转移

skb数据推送给第三方后，如果响应同步成功，skb会标记数据为已转移
支持第三方调用该接口，将转移状态变更为未转移（如：数据在第三方系统删除了）

请求路径

• https://skb.weiwenjia.com/api_skb/v1/isys/clues/modify_non_synced

请求方法

• put

headers

请求参数:

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": "参数错误" // 错误消息
}