客户资料同步接口

这里是客户资料同步接口v20160818版本,如需要最新v20170418版本,前往新版客户资料同步接口

注意:本接口的使用需要进行接口鉴权

1.获取客户数据库版本号、字段结构接口

接口:

POST {url}/v20160818/customer/getTemplate

请求限制:

频次限制:20次/每分钟

请求url:

http://apis.7moor.com/v20160818/customer/getTemplate/N00000000556
?sig=3E92F146297FCA751F63493877EC9719

请求体:

响应码:

代码 含义
200 请求成功
400 请求体参数错误
403 接口访问频次达到上限
500 服务器错误

返回200事例:

返回400事例:

{
    "code": 400,
    "message": "Please check your parameters"
}

返回403事例:

{
    "code": 403,
    "message": "Server is busy, max request frequency is 20/min"
}

返回值

字段 含义
code 响应码
message 响应信息
data 返回数据,JSON格式

data

version 数据库版本号作用:因为客户模板字段是用户可以自己配置的,所以数据库字段经常会发生变化,为了保证客户数据和用户配置的客户模板保持一致,所以对客户模板加一个版本号字段,所有对客户数据的增删改查操作都需要带上版本号,如果该版本号和客户模板中的版本号不一致,那么该操作失败。
template_type 客户类型company:企业客户 personal:个人客户
status 客户状态,默认四个 ,必填(单选,插入、修改数据时传Key值,例如status0status0 : 普通客户status1: 牌客户
status2: 金牌客户
status3 : VIP客户
source 数据来源,单选
stable_fields 客户默认字段,企业客户10个,个人客户13举例: "name" : 字段id "value" : 字段名称
"required" : 是否必填,requied:必填 空:非必填
"example": 字段类型、传参举例
插入、修改数据时根据"name"匹配字段
custom_fields 自定义字段 数量不限插入、修改数据时根据"name"匹配字段

企业客户stable_fields

属性name 属性value 备注
name 公司名称 默认必填
title 描述
phone 联系人电话 Object数组类型[{"tel":"130xxxxxxxx","memo":"备注"}]tel: 手机号,
memo: 备注
email 联系人邮箱 Object数组类型[{"email":"example@163.com","memo":"备注"}]email: 邮箱,
memo: 备注
weixin 微信 Object数组类型:[{"num":"example001","memo":"备注"}]num: 微信号,
memo: 备注
province 直辖市带"",例如: "北京市"普通省份带"",例如: "山东省"
city 带"市",例如:"北京市", "石家庄市"
address 公司地址
note 备注
web 公司网站

个人客户stable_fields

属性name 属性value 备注
name 公司名称 默认必填
title 描述
phone 联系人电话 Object数组类型[{"tel":"130xxxxxxxx","memo":"备注"}]tel: 手机号, memo: 备注
email 联系人邮箱 Object数组类型[{"email":"example@163.com","memo":"备注"}]email: 邮箱, memo: 备注
weixin 微信 Object数组类型:[{"num":"example001","memo":"备注"}]num: 微信号,
memo: 备注
province 直辖市带"",例如: "北京市"普通省份带"",例如: "山东省"
city 带"市",例如:"北京市", "石家庄市"
address 公司地址
note 备注
web 公司网站
sex 性别 "0":"1":
age 年龄
birth 生日 Date类型,"yyyy-MM-dd"

客户自定义字段custom_fields,客户自定义字段有七种类型,分别是单行文本、多行文本、数字、日期、下拉框、复选框、单选框,每种类型的字段可以设置多个。

类型id 类型名称 备注
single 单行文本
multi 多行文本
number 数字 数据类型:String,格式:正整数,例如"23"
date 日期 数据类型:String,格式:Date "yyyy-MM-dd"
dropdown 下拉框 返回数据中带可选属性choices,例如:,"choices":{"0":"1","1":"3","2":"多次"}
checkbox 复选框 返回数据中带可选属性choices,例如:,"choices": {"0":"开朗","1":"大方","2":"顽固"}
radio 单选框 返回数据中带可选属性choices,例如:,"choices": "choices":{"0":"","1":""}

2.新增客户资料数据接口

支持批量添加客户数据

接口:

POST {url}/v20160818/customer/insert

请求限制:

频次限制:20次/分钟

插入数据限制:每次最多插入500条客户数据

请求url:

http://apis.7moor.com/v20160818/customer/insert/N00000000556
?sig=3E92F146297FCA751F63493877EC9719

注意,如果需要给客户自定义id,需使用v20170418版本接口。 前往新版客户资料同步接口

请求体

字段 类型 备注
version String,必填 版本号
customers Object类型数组,必填 status:客户状态 必填
source:数据来源
stable_fields:固定属性,企业客户和个人客户有差别,具体属性见获取客户资料接口返回值详解
custom_fields:客户自定义属性,具体属性见获取客户资料接口返回值详解
owner:归属坐席

请求体事例:

{
    "version": "201610100019",
    "customers": [
        {
            "status": "status1",
            "source": "谷歌",
            "name": "导入客户测试10",
            "title": "标题",
            "phone": [
                {
                    "tel": "13512345678"
                },
                {
                    "tel": "13010202030"
                }
            ],
            "email": [
                {
                    "email": "234@qq.com"
                },
                {
                    "email": "3444@qq.com"
                }
            ],
            "weixin": [
                {
                    "num": "23e4"
                },
                {
                    "num": "234"
                }
            ],
            "province": "山东省",
            "city": "德州市",
            "address": "海淀区",
            "note": "备注",
            "web": "www.xxx.com",
            "qq账号": "666666",
            "备注": "23344",
            "年龄": "23",
            "建立时间": "2016-10-09",
            "见面次数": "2",
            "性格": [
                "0",
                "2"
            ],
            "性别": "0"
        }
    ]
}

响应代码

代码 含义
200 请求成功
210 客户信息符合要求的保存成功,返回不符合要求的客户信息
400 请求参数错误
403 接口访问频次达到上限或者插入客户数据大于500
500 服务器错误

返回200事例:

{
    "code": 200,
    "message": "success!"
}

返回210事例:

{
    "code": 210,
    "message": "has some error data",
    "errorData": [
        {
            "status": "status1",
            "source": "谷歌",
            "name": "导入客户测试10",
            "title": "标题",
            "phone": [
                {
                    "tel": "13512345678"
                },
                {
                    "tel": "13010202030"
                }
            ],
            "email": [
                {
                    "email": "234@qq.com"
                },
                {
                    "email": "3444@qq.com"
                }
            ],
            "weixin": [
                {
                    "num": "23e4"
                },
                {
                    "num": "234"
                }
            ],
            "province": "山东省",
            "city": "德州市",
            "address": "海淀区",
            "note": "备注",
            "web": "www.xxx.com",
            "qq账号": "666666",
            "备注": "23344",
            "年龄": "123",
            "建立时间": "2016-10-09",
            "见面次数": "2",
            "性格": [
                "0",
                "2"
            ],
            "性别": "2"
        }
    ]
}

返回400事例:

{
    "code": 400,
    "message": "Please check your parameters"
}

返回403事例:

{
    "code": 403,
    "message": "Server is busy, max request frequency is 20/min"
}

或者

{
    "code": 403,
    "message": "Insert data amount is too many, max insert amount is 100"
}

3.修改客户资料数据接口

接口:

POST {url}/v20160818/customer/update

请求限制:

频次限制:20次/分钟

请求url:

http://apis.7moor.com/v20160818/customer/update/N00000000556
?sig=3E92F146297FCA751F63493877EC9719

请求体:

字段 类型 备注
customer Object类型 必填 _id: 主键 必填
version:版本号 必填
status:客户状态 必填
source:数据来源
owner:归属坐席
stable_fields:固定属性,企业客户和个人客户有差别,具体属性见获取客户资料接口返回值详解
custom_fields:客户自定义属性,具体属性见获取客户资料接口返回值详解

请求体事例:

{
    "customer": {
        "_id": "4cf77790-8eb5-11e6-9bef-37ee1675947e",
        "version": "201610100019",
        "status": "status1",
        "source": "谷歌",
        "name": "导入客户测试10",
        "title": "标题",
        "phone": [
            {
                "tel": "13512345678"
            },
            {
                "tel": "13010202030"
            }
        ],
        "email": [
            {
                "email": "234@qq.com"
            },
            {
                "email": "3444@qq.com"
            }
        ],
        "weixin": [
            {
                "num": "23e4"
            },
            {
                "num": "234"
            }
        ],
        "province": "山东省",
        "city": "德州市",
        "address": "海淀区",
        "note": "备注",
        "web": "www.xxx.com",
        "qq账号": "666666",
        "备注": "23344",
        "年龄": "123",
        "建立时间": "2016-10-09",
        "见面次数": "2",
        "性格": [
            "0",
            "2"
        ],
        "性别": "0"
    }
}

响应代码:

代码 含义
200 请求成功
400 请求参数错误
403 接口访问频次达到上限
500 服务器错误

返回200事例:

{
    "code": 200,
    "message": "success!"
}

返回400事例:

{
    "code": 400,
    "message": "Please check your parameters"
}

返回403事例:

{
    "code": 403,
    "message": "Server is busy, max request frequency is 20/min"
}

4.删除客户资料数据接口

支持批量删除客户数据

接口:

POST {url}/v20160818/customer/delete

请求限制:

频次限制:10次/分钟

删除数据限制:每次最多删除500条客户数据

请求url:

http://apis.7moor.com/v20160818/customer/delete/N00000000556
?sig=3E92F146297FCA751F63493877EC9719

请求体:

字段 类型 备注
ids String类型数组,必填 客户资料数据主键

请求体事例:

{
    "ids": [
        "52163270-8eb5-11e6-9bef-37ee1675947e",
        "4cf77790-8eb5-11e6-9bef-37ee1675947e"
    ]
}

响应代码:

代码 含义
200 请求成功
210 客户id正确的删除成功,返回错误的客户id
400 请求体参数错误
403 接口访问频次达到上限或者删除数据大于100
500 服务器错误

返回200事例:

{
    "code": 200,
    "message": "success!"
}

返回210事例:

{
    "code": 210,
    "message": "has some error data",
    "errotData": {
        "version": "20161010009",
        "ids": [
            "4cf77790-8eb5-11e6-9bef-37ee1675947e",
            "52163270-8eb5-11e6-9bef-37ee1675947e"
        ]
    }
}

返回400事例:

{
    "code": 400,
    "message": "Please check your parameters"
}

返回403事例:

{
    "code": 403,
    "message": "Server is busy, max request frequency is 20/min"
}

或者

{
    "code": 403,
    "message": "Delete data amount is too many, max delete amount is 100"
}

5.查询客户资料数据接口

支持分页查询

接口:

POST {url}/v20160818/customer/select

请求限制:

频次限制:20次/每分钟

查询数据限制:默认最多返回1000条数据

请求url:

http://apis.7moor.com/v20160818/customer/select/N00000000556
?sig=3E92F146297FCA751F63493877EC9719

请求体

字段 类型 备注
version String 必填 版本号
_id String 非必填 客户主键
name String 非必填 公司名称
phone String 非必填 联系人电话
beginCreateTime 类型String 格式Date "yyyy-MM-dd" 非必填 大于创建时间
endCreateTime 类型String 格式Date "yyyy-MM-dd" 非必填 小于创建时间
beginLastUpdateTime 类型String 格式Date "yyyy-MM-dd" 非必填 大于最后修改时间
endLastUpdateTime 类型String 格式Date "yyyy-MM-dd" 非必填 小于最后修改时间
page int 非必填 默认1 查询第几页数据
pageSize int 非必填 默认1000 每页数量

请求体事例

{
    "version": "201610100019",
    "_id": "bfab4500-8f5a-11e6-8517-25d9c27afcd7",
    "name":"导入客户测试10",
    "phone":"13512345678",
    "beginCreateTime": "2016-10-11",
    "page": 1,
    "pageSize": 2
}

响应代码:

代码 含义
200 请求成功
400 请求体参数错误
403 接口访问频次达到上限
500 服务器错误

返回200事例:

{
    "code": 200,
    "message": "success!",
    "data": [
        {
            "_id": "bfab4500-8f5a-11e6-8517-25d9c27afcd7",
            "accountId": "N00000000556",
            "version": "201610100019",
            "createTime": "2016-10-11 10:31:00",
            "phone": [
                {
                    "tel": "13512345678",
                    "memo": ""
                },
                {
                    "tel": "13010202030",
                    "memo": ""
                }
            ],
            "email": [
                {
                    "email": "234@qq.com"
                },
                {
                    "email": "3444@qq.com"
                }
            ],
            "weixin": [
                {
                    "num": "23e4",
                    "memo": ""
                },
                {
                    "num": "234",
                    "memo": ""
                }
            ],
            "status": "status1",
            "name": "导入客户
测试10",
            "title": "标题",
            "province": "bac009de-5bfd-4f33-913e-5194eeb0f77b",
            "city": "3cd74d1b-23b6-4088-a734-7f87b0f3a720",
            "address": "海淀区",
            "note": "备注",
            "web": "www.xxx.com",
            "source": "谷歌",
            "qq账号": "666666",
            "备注": "23344",
            "年龄": "123",
            "建立>时间": "2016-10-09",
            "见面次数": "2",
            "性格": [
                "0",
                "2"
            ],
            "性别": "0"
        }
    ]
}

返回400事例:

{
    "code": 400,
    "message": "Please check your parameters"
}

返回403事例:

{
    "code": 403,
    "message": "Server is busy, max request frequency is 20/min"
}