客户中心

API列表

编号 API名称 路径 版本
1.1 根据客户id获取客户信息 /tx/platform-biz/remac-tx-customer/customer/load/{id} 1.0
1.2 根据客户id列表获取客户信息列表 /tx/platform-biz/remac-tx-customer/customer/load/ids 1.0
1.3 根据关键字获取客户信息 /tx/platform-biz/remac-tx-customer/customer/queryByKeyword 1.0
1.4 获取全量客户列表数据 /tx/platform-biz/remac-tx-customer/customer/queryAllCustomer 1.0

API调用

1、客户管理

1.1: 根据客户id获取客户信息

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-customer/customer/load/{id}

HTTP头： bizToken

方法：GET

请求参数

名称 类型 必填 描述
id Long 是 客户id

请求示例

GET  http://ip:port/tx/platform-biz/remac-tx-customer/customer/load/79
返回参数类型

JSON

返回参数

名称 类型 必填 描述
id Long 是 客户id
name String 是 客户名称
firstName String 否 姓氏
lastName String 否 名字
customerNo String 否 客户编号
nickName String 否 客户昵称
pinyinName String 是 客户名称拼音信息(声调用数字表示)
pinyinInfo String 是 客户名称拼音信息(全拼)
pinyinNamePrefix String 是 客户姓氏拼音首字母
type Integer 是 类型，0-个人类型客户, 1-公司类型客户
isPublic Integer 是 归属，0-私有，1-公共
url String 否 客户图标
extraAttr String 否 额外属性
remark String 否 备注
gender Integer 否 性别，0-女，1-男,-1-未知
age Integer 否 年龄, -1未知
birthday date 否 客户图标
marriage Integer 否 婚姻情况，0-未婚，1-已婚,-1-未知
company String 否 公司
position String 否 职位
job String 否 职业
education String 否 教育情况
email String 否 邮箱
wechat String 否 微信
qqNumber String 否 QQ号
createTime Date 否 创建时间
updateTime Date 否 修改时间
createBy String 否 创建人
updateBy String 否 修改人
sourceId Long 否 平台id,兼容历史数据
sourceType Integer 否 来源，0-天策,1-天工
status Integer 否 状态，0正常
customerId Long 否 客户id
provinceCode String 否 省编码
cityCode String 否 市编码
townCode String 否 镇编码
streetCode String 否 街道&乡镇编码
addressDetail String 否 详细地址
fullAddress String 否 完整地址
addrFlag Integer 否 地址标识：0-家,1-公司
isDefault Integer 否 是否为默认，0-否, 1-是
mobile String 否 电话

​

返回结果示例
{
    "code": "200",
    "message": "请求成功",
    "data": {
        "id": 79,
        "name": "桂芳",
        "firstName": "",
        "lastName": "",
        "customerNo": "",
        "nickName": "",
        "pinyinName": "gui4 fang1",
        "pinyinInfo": "guifang",
        "pinyinNamePrefix": "G",
        "type": 0,
        "isPublic": 0,
        "url": "",
        "extraAttr": "#FF4D4F",
        "remark": "",
        "gender": -1,
        "age": -1,
        "birthday": null,
        "marriage": -1,
        "company": "",
        "position": "",
        "job": "",
        "education": "",
        "email": "",
        "wechat": "",
        "qqNumber": "",
        "createTime": "2022-10-25 17:35:58",
        "updateTime": "2023-01-03 14:06:04",
        "createBy": "15625059654",
        "updateBy": "15625059654",
        "sourceId": 79,
        "sourceType": 1,
        "status": 0,
        "customerAddressList": [
            {
                "customerId": 79,
                "provinceCode": "120000",
                "cityCode": "120100",
                "townCode": "120101",
                "streetCode": null,
                "addressDetail": "fadf",
                "fullAddress": "",
                "addrFlag": 0,
                "isDefault": 0
            }
        ],
        "customerPhoneList": [
            {
                "customerId": 79,
                "name": "桂芳",
                "mobile": "15625059654",
                "remark": null,
                "isDefault": 0
            }
        ]
    }
}

1.2: 根据客户id列表获取客户信息列表

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-customer/customer/load/ids

HTTP头：bizToken

方法：POST/JSON

请求参数

名称 类型 必填 描述
idList List 是 客户id列表

请求Body描述

{
    "idList": [72,79]
}
返回参数类型

JSON

返回参数

名称 类型 必填 描述
见1.1接口参数说明
返回结果示例
{
    "code": "200",
    "message": "请求成功",
    "data": [
        {
            "id": 72,
            "name": "没有",
            "firstName": "",
            "lastName": "",
            "customerNo": "",
            "nickName": "",
            "pinyinName": "mei2 you3",
            "pinyinInfo": "mei you",
            "pinyinNamePrefix": "M",
            "type": 1,
            "isPublic": 0,
            "url": "https://mideazy-test-public.oss-cn-hangzhou.aliyuncs.com/file/upload/product/2022-10-25/1666682937955/blob",
            "extraAttr": null,
            "remark": "我不去想是否能够成功\n既然选择了远方\n便只顾风雨兼程\n\n我不去想能否赢得爱情\n既然钟情于玫瑰\n就勇敢地吐露真诚\n\n我不去想身后会不会袭来寒风冷雨\n既然目标是地平线\n留给世界的只能是背影\n\n我不去想未来是平坦还是泥泞\n只要热爱生命\n\n一切，都在意料之中",
            "gender": -1,
            "age": -1,
            "birthday": null,
            "marriage": -1,
            "company": "",
            "position": "",
            "job": "",
            "education": "",
            "email": "",
            "wechat": "",
            "qqNumber": "",
            "createTime": "2022-10-25 15:29:22",
            "updateTime": "2022-10-25 15:30:42",
            "createBy": "18898625142",
            "updateBy": "18898625142",
            "sourceId": 72,
            "sourceType": 1,
            "status": 0,
            "customerAddressList": [
                {
                    "customerId": 72,
                    "provinceCode": "440000",
                    "cityCode": "440600",
                    "townCode": "440606",
                    "streetCode": null,
                    "addressDetail": "我不去想是否能够成功\n既然选择了远方\n便只顾风雨兼程\n\n我不去想能否赢得爱情\n既然钟情于玫瑰\n就勇敢",
                    "fullAddress": "",
                    "addrFlag": 0,
                    "isDefault": 0
                }
            ],
            "customerPhoneList": [
                {
                    "customerId": 72,
                    "name": "15",
                    "mobile": "19874142949",
                    "remark": null,
                    "isDefault": 0
                }
            ]
        },
        {
            "id": 79,
            "name": "桂芳",
            "firstName": "",
            "lastName": "",
            "customerNo": "",
            "nickName": "",
            "pinyinName": "gui4 fang1",
            "pinyinInfo": "gui fang",
            "pinyinNamePrefix": "G",
            "type": 0,
            "isPublic": 0,
            "url": "",
            "extraAttr": "#FF4D4F",
            "remark": "",
            "gender": -1,
            "age": -1,
            "birthday": null,
            "marriage": -1,
            "company": "",
            "position": "",
            "job": "",
            "education": "",
            "email": "",
            "wechat": "",
            "qqNumber": "",
            "createTime": "2022-10-25 17:35:58",
            "updateTime": "2023-01-03 14:06:04",
            "createBy": "15625059654",
            "updateBy": "15625059654",
            "sourceId": 79,
            "sourceType": 1,
            "status": 0,
            "customerAddressList": [
                {
                    "customerId": 79,
                    "provinceCode": "120000",
                    "cityCode": "120100",
                    "townCode": "120101",
                    "streetCode": null,
                    "addressDetail": "fadf",
                    "fullAddress": "",
                    "addrFlag": 0,
                    "isDefault": 0
                }
            ],
            "customerPhoneList": [
                {
                    "customerId": 79,
                    "name": "桂芳",
                    "mobile": "15625059654",
                    "remark": null,
                    "isDefault": 0
                }
            ]
        }
    ]
}

1.3: 根据关键字获取客户信息

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-customer/customer/queryByKeyword

HTTP头：bizToken

方法：POST/JSON

请求参数

名称 类型 必填 描述
keyword String 否 客户姓名/客户手机号
type Integer 否 类型，0-个人类型客户, 1-公司类型客户
pageNo Integer 是 页码
pageSize Integer 是 每页条数

请求Body描述

{
    "keyword":"蓝莓",
    "type":0,
    "pageNo":1,
    "pageSize": 2
}
返回参数类型

JSON

返回参数

名称 类型 必填 描述
见1.1接口参数说明
返回结果示例
{
  "code": "200",
  "message": "请求成功",
  "data": {
    "result": [
      {
        "id": 129,
        "name": "蓝莓",
        "firstName": "",
        "lastName": "",
        "customerNo": "",
        "nickName": "",
        "pinyinName": "lan2 mei2",
        "pinyinInfo": "lanmei",
        "pinyinNamePrefix": "L",
        "type": 0,
        "isPublic": 0,
        "url": "",
        "extraAttr": null,
        "remark": "测试",
        "gender": -1,
        "age": -1,
        "birthday": null,
        "marriage": -1,
        "company": "",
        "position": "",
        "job": "",
        "education": "",
        "email": "",
        "wechat": "",
        "qqNumber": "",
        "createTime": "2022-10-29 15:01:18",
        "updateTime": "2022-10-29 15:01:18",
        "createBy": "ouyonghua01",
        "updateBy": "ouyonghua01",
        "sourceId": 129,
        "sourceType": 1,
        "status": 0,
        "customerAddressList": [
          {
            "customerId": 129,
            "provinceCode": "650000",
            "cityCode": "659000",
            "townCode": "659008",
            "streetCode": null,
            "addressDetail": "工业大道南提案及国际大厦202房",
            "fullAddress": "",
            "addrFlag": 0,
            "isDefault": 0
          }
        ],
        "customerPhoneList": [
          {
            "customerId": 129,
            "name": "蓝莓",
            "mobile": "15678968555",
            "remark": null,
            "isDefault": 0
          }
        ],
        "pageNo": 1,
        "pageSize": 2,
        "total": 1
      }
      ]
  }
}

1.4: 获取全量客户列表数据

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-customer/customer/queryAllCustomer

HTTP头：bizToken

方法：GET

返回参数类型

JSON

返回结果示例
{
  "code": "200",
  "message": "请求成功",
  "data": [
    {
      "id": 322,
      "name": "%100诚信",
      "firstName": "",
      "lastName": "",
      "customerNo": "",
      "nickName": "",
      "pinyinName": "% 1 0 0 cheng2 xin4",
      "pinyinInfo": "%100chengxin",
      "pinyinNamePrefix": "%",
      "type": 1,
      "isPublic": 0,
      "url": "https://mideazy-test-public.oss-cn-hangzhou.aliyuncs.com/file/upload/product/2023-01-04/1672821627827/blob",
      "extraAttr": "#9254DE",
      "remark": "",
      "gender": -1,
      "age": -1,
      "birthday": null,
      "marriage": -1,
      "company": "",
      "position": "",
      "job": "",
      "education": "",
      "email": "",
      "wechat": "",
      "qqNumber": "",
      "createTime": "2023-01-04 16:40:49",
      "updateTime": "2023-01-04 16:40:49",
      "createBy": "17748679135",
      "updateBy": "17748679135",
      "sourceId": 322,
      "sourceType": 1,
      "status": 0,
      "customerAddressList": [
        {
          "customerId": 322,
          "provinceCode": "110000",
          "cityCode": "110100",
          "townCode": "110105",
          "streetCode": null,
          "addressDetail": "公安分局",
          "fullAddress": "",
          "addrFlag": 0,
          "isDefault": 0
        }
      ],
      "customerPhoneList": [
        {
          "customerId": 322,
          "name": "胡大民",
          "mobile": "15956423156",
          "remark": null,
          "isDefault": 0
        }
      ]
    },
    {
      "id": 392,
      "name": "11111",
      "firstName": "",
      "lastName": "",
      "customerNo": "",
      "nickName": "",
      "pinyinName": "1 1 1 1 1",
      "pinyinInfo": "11111",
      "pinyinNamePrefix": "1",
      "type": 1,
      "isPublic": 0,
      "url": "https://mideazy-test-public.oss-cn-hangzhou.aliyuncs.com/file/upload/product/2023-01-12/1673505707038/blob",
      "extraAttr": "#FFC53D",
      "remark": "11111",
      "gender": -1,
      "age": -1,
      "birthday": null,
      "marriage": -1,
      "company": "",
      "position": "",
      "job": "",
      "education": "",
      "email": "",
      "wechat": "",
      "qqNumber": "",
      "createTime": "2023-01-12 14:40:17",
      "updateTime": "2023-01-12 14:41:53",
      "createBy": "18688298849",
      "updateBy": "18688298849",
      "sourceId": 392,
      "sourceType": 1,
      "status": 0,
      "customerAddressList": [
        {
          "customerId": 392,
          "provinceCode": "440000",
          "cityCode": "440600",
          "townCode": "440606",
          "streetCode": null,
          "addressDetail": "1111111111",
          "fullAddress": "",
          "addrFlag": 0,
          "isDefault": 0
        }
      ],
      "customerPhoneList": [
        {
          "customerId": 392,
          "name": "1111",
          "mobile": "18688298849",
          "remark": null,
          "isDefault": 0
        }
      ]
    }
  ]
}

2.1: 接收推送触发同步客户信息(中台内部调用)

描述： 接收推送触发同步客户信息(中台内部调用)

HTTP协议：HTTP HTTPS

URL: /tx/platform-biz/remac-tx-customer/customer/sync/doCustomerSync

方法：POST

请求参数:

详见此页面 4.8.2: https://confluence.mideazy.com/pages/viewpage.action?pageId=491323439

Copyright © www.remacsmart.com/ 2021 all right reserved，powered by Gitbook该文件修订时间： 2023-06-29 10:14:48

results matching ""

    No results matching ""