API开发文档 - 道一云

开发说明

开发说明

功能说明：获取到客户信息
请求方式：POST（HTTPS）
请求地址：https://qwif.do1.com.cn/qwcgi/api/crmAction/getClientInfo.do?token=token&corpId=corpId

请求包体：

{
    "startTimes":"2018-01-01",
    "endTime":"2018-03-01",
    "startUpdateTime":"2019-07-15",
    "endUpdateTime":"2019-08-15",
    "pageSize":10,
    "currentPage":1,
    "searchValue": {
        "clientName": "道一",
        "phone": "13333445566"
    }
}

请求参数说明：

参数	说明	类型	是否必须	备注
token	用于验证	String	是	详见道一云平台TOKEN接口文档
corpId	公司唯一标识	String	是	企业corpId
startTimes	创建时间开始点	String	是	时间格式为yyyy-MM-dd
endTime	创建时间结束点	String	是	创建时间间隔不的超过两个月
startUpdateTime	更新时间开始点	String	否	时间格式为yyyy-MM-dd
endUpdateTime	更新时间结束点	String	否	时间格式为yyyy-MM-dd
currentPage	查询页码	int	是	必须为正整数,如果当前页超过最大页数,则当前页默认为最大页
pageSize	分页大小	int	否	默认为100,并且不超过1000
searchValue	模糊查询条件	JSON	否

searchValue

参数	说明	类型	是否必填	备注
clientName	客户名	String	否
phone	联系电话	String	否	电话号码格式

SDK调用示例：

		// 创建请求的参数
		CrmDataPush vo = new CrmDataPush();
		// 设置当前页面
		vo.setCurrentPage(1);
		// 设置页面大小
		vo.setPageSize(10);
		// 设置将要查询的客户信息的创建时间范围（不超过两个月）
		vo.setStartTimes("2018-01-01");
		vo.setEndTime("2018-03-01");
		// 设置clientName模糊查询
		vo.setSearchValue(vo.new SearchValue("测试","13333445566"));
		System.out.println(JSONUtil.stringify(vo));
		CrmApi api = QwSdkUtil.getInter(CrmApi.class);
		// 调用接口
		CrmClientInfoPageResult clientVO = api.getClientInfo(
				QwSdkUtil.getCacheToken(), vo);
		System.out.println(JSONUtil.stringify(clientVO));

返回结果：

{
  "code": "0",
  "desc": "成功",
  "data": {
    "currentPage": 1,
    "pageSize": 10,
    "maxPage": 10,
    "totalRows": 10,
    "pageData": [
      {
        "id": "e6e5ceb0-c93f-4d3c-b739-eb0d73d58902",
        "clientCode": "20180129175927",
        "clientName": "道一信息",
        "ccPersonIds": "13416436222",
        "ccPersonNames": "负责人名称",
        "provinceCode": "广东省",
        "cityCode": "广州市",
        "areaCode": "天河区",
        "address": "员村一横路3号",
        "typeNames": "意向客户",
        "phone": "13333445566",
        "email": "xxx@do1.com.cn",
        "industry": "计算机软件",
        "creator": "test",
        "personName": "道一云开发平台",
        "wxUserId": "13416436222",
        "createTime": "2018-01-29 18:00:40",
        "relativePersonIds": "xiaoming,xiaoli",
        "relativePersonNames": "小明、小李",
        "comment": "【道一云】,【已阅】,【2017-12-07】",
        "remark": "备注信息",
        "updateTime": "2018-02-01 15:07:23",
        "website": "www.do1.com.cn",
        "optionMap": {
        "选项": "选项1",
        "日期": "2018-02-01 14:04",
        "联系电话": "134302xxxxx",
        "单行文本": "xxxxx",
        "多行文本": "xxxxx"
        }
      }
    ]
  }
}

返回参数说明：

参数	说明
currentPage	当前页
pageSize	分页大小
maxPage	最大页
totalRows	信息总条数

pageData参数	说明
id	客户ID
clientCode	客户编码
clientName	客户名称
ccPersonIds	负责人ID，两个以上用英文逗号“,”隔开
ccPersonNames	负责人名称，两个以上用英文逗号“,”隔开
provinceCode	省份
cityCode	市
areaCode	区（县）
address	地址
typeNames	客户类别，两个以上用英文逗号“,”隔开
phone	手机号
email	邮箱地址
industry	所在行业，两个以上用英文逗号“,”隔开
creator	创建人ID
personName	创建人名称
wxUserId	创建人账号
createTime	创建时间
relativePersonIds	相关人账号，两个以上用英文逗号“,”隔开
relativePersonNames	相关人名称，两个以上用英文逗号“,”隔开
comment	审批/评论信息，两个以上用英文逗号“,”隔开
remark	备注信息
updateTime	更新时间
website	网址
optionMap	自定义字段键值对

企业微信

获取客户信息列表

开发说明