API文档

# 根据手机号查询客户是否存在

# 接口说明

项 值
URL /v1/crm/leads/exists.json
描述 根据手机号查询客户是否存在
请求方式 POST
需要登录 否
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
mobile string 客户手机号。精确匹配 是
productLineId string 销售线ID。单销售线模式下可以不传这个参数 否

# 请求数据

{
    "mobile": "13344445555", // 客户手机号。精确匹配
    "productLineId": "abc"   // 销售线ID。单销售线模式下可以不传这个参数
}

# 返回数据

{
    "code" : 0,
    "msg" : "",
    "data" : true, // true 存在 false 不存在
    "pageDto" : null
}

# 新增客户

# 接口说明

项 值
URL /v1/crm/leads/add.json
描述 新增客户
请求方式 POST
需要登录 否
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
allocRule int 客户分配方式 1-交给客服清洗 2-分配到个人临时库 3-分配到部门公海 4-分配到公海。若不填默认值为1 否
allocUserId string 分配用户ID，当 allocRule = 2 时必填。 否
allocOrgId string 分配部门ID，当 allocRule = 3 时必填。 否
creatorId string 录入人ID 否
marketUserId string 推广人ID 否
channelId string 渠道ID，见获取数据渠道 否
productLineId string 销售线ID，当企业设置为多销售线模式时必填，见获取销售线列表 否
mobile string 手机号. 最长16字符 是
name string 姓名，最长32字符 否
idNum string 身份证号，最长32字符 否
areaId string 客户所在城市，使用国家行政区划编码。6位 否
gender int 性别 0-未知 1-男 2-女 否
age int 年龄 否
qq string QQ，最长32字符 否
wechat string 微信，最长32字符 否
mail string 邮箱，最长256字符 否
graduated string 毕业院校，最长64字符 否
education string 学历，最长64字符（可选：小学, 初中, 中专/高中, 专科, 本科, 研究生, 博士） 否
major string 专业，最长64字符 否
p1 ~ p20 string 自定义字段，具体定义请查看数据字典，最长512字符 否
extType string 额外数据类型，最长256字符 否
extValue string 额外数据内容，最长512字符 否
birthday string 生日，20200202 否
schoolId int 所属校区id 否
schoolName string 所属校区名称 否
registerStatus int 注册状态 否

# 请求数据

{
    "allocRule": 1,                    // 客户分配方式 1-交给客服清洗 2-分配到个人临时库 3-分配到部门公海 4-分配到公海。若不填默认值为1
    "allocUserId": "",                 // 分配用户ID，当 allocRule = 2 时必填。
    "allocOrgId": "",                  // 分配部门ID，当 allocRule = 3 时必填。

    "creatorId": "",                   // 录入人ID
    "marketUserId": "",                // 推广人ID
    "channelId": "",                   // 渠道ID，见 /v1/channel/list.json

    "productLineId": "",               // 销售线ID（多销售线时必填）
    // 客户信息字段
    "mobile": "15872411165",           // 手机号（必填）

    "name": "王小二",                   // 姓名
    "idNum": "",                       // 身份证号
    "areaId": "420100",                // 客户所在城市，使用国家行政区划编码。6位
    "gender": 0,                       // 性别 0-未知 1-男 2-女
    "age": 12,                         // 年龄
    "qq": "",                          // QQ
    "wechat": "",                      // 微信
    "mail": "",                        // 邮箱
    "graduated": "",                   // 毕业院校
    "education": "",                   // 学历: 小学, 初中, 中专/高中, 专科, 本科, 研究生, 博士
    "major": "",                       // 专业

    // 自定义字段，具体定义请查看数据字典。
    "p1": "",
    "p2": "",
    "p3": "",
    "p4": "",
    "p5": "",
    "p6": "",
    "p7": "",
    "p8": "",
    "p9": "",
    "p10": "",
    "p11": "",
    "p12": "",
    "p13": "",
    "p14": "",
    "p15": "",
    "p16": "",
    "p17": "",
    "p18": "",
    "p19": "",
    "p20": "",

    "extType": "",      // 额外数据类型
    "extValue": ""      // 额外数据内容
}

# 返回数据

{
    "code" : 0,
    "msg" : ""
}

# 根据手机号查询客户绑定信息

# 接口说明

项 值
URL /v1/crm/leads/getBindInfo.json
描述 根据手机号查询客户绑定信息
请求方式 POST
需要登录 否
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
mobile string 客户手机号 是

# 请求数据

{
    "mobile": "13344445555"    // 客户手机号
}

# 返回数据

{
    "code" : 0,
    "msg" : "",
    "data" : {
      "mobile": "",
      "bindUser": "",                     //绑定人
      "bindUserId": "",
      "bindDept": "",
      "bindDeptId": "",
      "customerService": "",              //绑定客服
      "customerServiceId": ""             //绑定客服Id
    }
}

# 根据手机号批量查询客户绑定信息

# 接口说明

项 值
URL /v1/crm/leads/getBindInfos.json
描述 根据手机号批量查询客户绑定信息
请求方式 POST
需要登录 否
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
mobiles array 客户手机号 是

# 请求数据

{
    "mobiles": ["13344445555"]    // 客户手机号
}

# 返回数据

{
    "code" : 0,
    "msg" : "",
    "data" : [{
      "mobile": "",
      "bindUser": "",                     //绑定人
      "bindUserId": "",
      "bindDept": "",
      "bindDeptId": "",
      "customerService": "",              //绑定客服
      "customerServiceId": ""             //绑定客服Id
    }]
}

← 客户订单 →