功能说明:新增一个客户
请求方式:POST(HTTPS)
请求地址:https://qwif.do1.com.cn/qwcgi/api/crm/client/insertClientInfo.do?token=token&corpId=corpId
{
"address":"广东省广州市天河区员村一横路3号华颖轩1-2层",
"areaCode":"天河区",
"chargePersonWxIds":"mr_liu",
"cityCode":"广州市",
"clientCode":"2019120312000001",
"clientName":"道一",
"customFields":
[
{
"fieldId":"88e5411991e5f4c4010257611ac4aa9a",
"fieldValue":"13344445555"
},
{
"fieldId":"5f17acad9afbf1872630902dbab996e2",
"fieldValue":"50%"
},
{
"fieldId":"2f33bb8dbb242b4cc6be3653b39a14eb",
"fieldValue":"2019-12-03 12:00:"
},
{
"fieldId":"799e90edc846894d7e077f6f1cfaa2c1",
"fieldValue":"多行类型内容\n多行类型内容\n"
},
{
"fieldId":"31afb4319c55a3af9cf3bd34899c2735",
"fieldValue":"100000"
},
{
"fieldId":"60539fa786a1801b172182849da04fbc",
"fieldValue":"123.45"
},
{
"fieldId":"ea4f60fdf4540b45fab6d3e664f2c691",
"fieldValue":"单行内容"
},
{
"fieldId":"e88b441f0bf31d93bce64dc18762d81f",
"fieldValue":"1"
}
],
"email":"123456789@do1.com.cn",
"industryCodes":"0101,0501",
"latitude":"23.128263",
"longitude":"113.359385",
"phone":"13312031200",
"poolId":"0",
"provinceCode":"广东省",
"relatviePersonWxIds":"miss_zhang,mr_li",
"remark":"这是备注",
"submitType":"1",
"typeIds":"2190f0c74a4c4c02a6fc45419d126fac",
"website":"www.do1.com.cn",
"seniorFields":
[
{
"fieldId":"fod9e4acf33e9147128fd085e7712a50e3",
"fieldName":"高级字段-单行文字",
"fieldValue":"这是高级字段单行类型字段"
},
{
"fieldId":"foab338de2db0b449fa46cf375e9d87e3f",
"fieldName":"高级字段-邮箱",
"fieldValue":"123456789@qq.com"
},
{
"fieldId":"fo57b9b1ae81ad492c879050330d5eb3d6",
"fieldName":"高级字段-数字",
"fieldValue":"233"
},
{
"fieldId":"fo498bd7a5a3574807a9010882b70c334f",
"fieldName":"高级字段-电话",
"fieldValue":"020 12031200"
},
{
"fieldId":"fo62e8daa9b10f41848a1e264f7de4819b",
"fieldName":"高级字段-手机",
"fieldValue":"13312031200"
},
{
"fieldId":"fo61fd1ef6f36d4e5084f9a331b3d65b91",
"fieldName":"高级字段-多行文字",
"fieldValue":"这是高级字段多行文字类型\n这是高级字段多行文字类型\n"
},
{
"fieldId":"fo645321f1c7b9415dba84974cc3f39202",
"fieldName":"高级字段-日期",
"fieldValue":"2019-12-03"
},
{
"fieldId":"fo54af86e5f2494bb38a4de1a9282d0ad6",
"fieldName":"高级字段-时间",
"fieldValue":"18:00"
},
{
"fieldId":"fob0adb4f6a7fe440782995cf6426f9ad3",
"fieldName":"高级字段-日期时间",
"fieldValue":"2019-11-11 11:11"
},
{
"fieldId":"fo3674959396384edc8817651605913ccc",
"fieldName":"高级字段-单项选择",
"fieldValue":"选项1"
},
{
"fieldId":"fod9e4acf33e9147128fd085e7712a50e3",
"fieldName":"高级字段-多项选择",
"fieldValue":"选项1,选项2"
},
{
"fieldId":"foe99290cf57f84bfc814b70909a93fc4b",
"fieldName":"高级字段-下拉框",
"fieldValue":"选项1"
},
{
"fieldId":"foe779eae3b38d436c8c72ded5324ba8b0",
"fieldName":"高级字段-评分",
"fieldValue":"3"
},
{
"fieldId":"fo9982aebbdd9b423383e7182fbd57740c",
"fieldName":"高级字段-地理位置",
"fieldValue":"广东省广州市天河区员村一横路3号"
},
{
"fieldId":"fo6b8fdde86ec4472a972ec2b71edd7efa",
"fieldName":"高级字段-省市区",
"fieldValue":"广东省:广州市:天河区"
},
{
"fieldId":"fo521f8244ba3e4d6785602d4aee23a07d",
"fieldName":"高级字段-计算式",
"fieldValue":"466"
},
{
"fieldId":"fobb841af1252547b788d9c93c2baf27c3",
"fieldName":"高级字段-两级下拉框",
"fieldValue":"选项1:二级选项2"
},
{
"fieldId":"foc95fc853e5984552a77dc582a68e8962",
"fieldName":"高级字段-通讯录成员",
"fieldValue":"zhangsan,lisi"
},
{
"fieldId":"foa19a6a39b6d3402a870fc7987ae40e13",
"fieldName":"高级字段-部门",
"fieldValue":"一级部门A->二级部门B,一级部门B->二级部门C->三级部门D"
}
]
}
// 自定义高级字段中的参数fieldName仅做展示用,实际调用不需要传。
data参数
| 参数 | 说明 | 类型 | 是否必填 | 备注 |
| clientName |
客户名 |
String | 是 |
|
|
typeIds |
行业ID |
String |
根据字段的isNecessary值,1是必填,0为非必填 |
多个客户类型用英文逗号分隔 |
|
poolId |
所属公海ID |
String |
根据isNecessary填写 |
最多只能填一个所属公海ID。0表示默认公海。 |
| clientCode | 客户编码 | String | 选填 |
不填写时会自定生成。 |
|
provinceCode |
省 |
String |
根据isNecessary填写 |
这三个字段属于“区域”字段,由“区域”字段控制, 在新增时可拆分为省市区这三个字段填写。
(省、市、区)字段填写Demo: 广东省、广州市、天河区;内蒙古自治区、呼和浩特市、新城区; 香港特别行政区、香港岛、湾仔区;上海市、上海市、黄浦区。 |
|
cityCode |
市 |
String |
根据isNecessary填写 |
|
|
areaCode |
区(县) | String |
根据isNecessary填写 |
|
|
address |
地址 |
String |
根据isNecessary填写 |
|
|
latitude |
纬度 |
String |
否 |
|
|
longitude |
经度 |
String | 否 |
|
|
industryCodes |
自定义行业code |
String |
根据isNecessary填写 |
多个行业code用英文逗号分隔 |
|
phone |
联系电话 |
String |
根据isNecessary填写 |
手机号码格式 |
|
|
邮箱 |
String |
根据isNecessary填写 |
电子邮箱格式 |
|
website |
网站 |
String |
根据isNecessary填写 |
|
|
remark |
备注 |
String |
根据isNecessary填写 |
|
|
chargePersonWxIds |
负责人 |
String |
是 |
微信ID。 获取客户字段接口结果中的multiClientSetting = true时, 可以填多个,多个负责人WxId用英文逗号分隔; multiClientSetting = false,只能填一个。 |
|
relatviePersonWxIds |
相关人 |
String |
根据isNecessary填写 |
微信ID,多个相关人WxId用英文逗号分隔。 |
|
submitType |
通知状态 |
String |
根据isNecessary填写 |
0 后台只保存;1 保存并通知; |
|
customFields |
自定义字段 |
JSON |
|
|
| seniorFields | 自定义高级字段 | JSON |
|
|
customField
| 参数 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
|
fieldId |
自定义字段ID |
String | 根据isNecessary填写 |
填写从获取客户字段接口返回的对应的自定义字段ID |
|
fieldValue |
fieldValue |
String |
根据isNecessary填写 |
SelectField类型数据填写对应choices的选项值value;
Percent类型必须有百分号;
Double类型必须精确到小数点后两位; DateTime类型只能是yyyy-MM-dd或者yyyy-MM-dd hh:mm:ss格式 |
seniorField
| 参数 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
|
fieldId |
自定义高级字段ID |
String | 根据isNecessary填写 |
填写从获取客户字段接口返回的对应的自定义高级字段ID |
|
fieldValue |
fieldValue |
String |
根据isNecessary填写 |
各类型字段的填写根据下面的表格进行填写 |
自定义高级字段填写说明
| 类型 | 字段释义 | 填写说明 |
|---|---|---|
|
TextField |
单行文本 |
最多2000字符 |
|
NumberField |
数字 | 数字类型 |
|
EmailField |
邮箱 | 邮箱格式 |
|
TelephoneField |
电话 |
分隔用-或空格,国际电话加+ |
|
MobileField |
手机 |
手机格式 |
|
TextArea |
多行文本 |
最多2000字符 |
|
DateField |
日期 |
yy-MM-dd |
|
TimeField |
时间 |
hh:mm |
|
DateTimeField |
日期时间 |
yy-MM-dd hh:mm |
|
RadioButton |
单项选择 |
选项名,如:选项一 |
|
CheckBox |
多项选择 |
选项名,多个用英文逗号分隔。如:选项2,选项3 |
|
DropDown |
下拉框 |
选项名,如:选项一 |
|
RatingField |
评分 |
评分范围内的数字 |
|
GeoField |
地理位置 |
地理位置 |
|
CityField |
省市区 |
格式:xx省:xx市:xx区。英文冒号分隔 |
|
EquationField |
计算式 | 根据设置的计算规则填写 |
|
CascadeDropDown |
两级下拉框 |
填写获取字段接口返回结果里choices的某个选项的optionName。如:选项一:二级选项。 |
|
MEMBERCustomerField |
通讯录成员 |
通信录成员的wxUserId,多个成员英文逗号分隔 |
|
DEPTCustomerField |
部门 |
填写部门全称,层级用"->"链接,多个部门用英文逗号','分隔,如一级部门A->二级部门B,一级部门B->二级部门C->三级部门D |
// 创建请求参数
ClientInfoReqVO vo = new ClientInfoReqVO();
// 设置基础字段
vo.setClientName("道一");
vo.setTypeIds("2190f0c74a4c4c02a6fc45419d126fac");
vo.setPoolId("0");
vo.setClientCode("2019120312000001");
vo.setProvinceCode("广东省");
vo.setCityCode("广州市");
vo.setAreaCode("天河区");
vo.setAddress("广东省广州市天河区员村一横路3号华颖轩1-2层");
vo.setLatitude("23.128263");
vo.setLongitude("113.359385");
vo.setIndustryCodes("0101,0501");
vo.setPhone("13312031200");
vo.setEmail("123456789@do1.com.cn");
vo.setWebsite("www.do1.com.cn");
vo.setRemark("这是备注");
vo.setChargePersonWxIds("mr_liu");
vo.setRelativePersonWxIds("miss_zhang,mr_li");
vo.setSubmitType("1");
// 设置每一个自定义字段
CrmCommonCustomFieldValueVO dateTime = new CrmCommonCustomFieldValueVO("2f33bb8dbb242b4cc6be3653b39a14eb", "2019-12-03 12:00");
CrmCommonCustomFieldValueVO textArea = new CrmCommonCustomFieldValueVO("799e90edc846894d7e077f6f1cfaa2c1", "132\\n456\\n789\\n");
CrmCommonCustomFieldValueVO phoneNumber = new CrmCommonCustomFieldValueVO("88e5411991e5f4c4010257611ac4aa9a", "13344445555");
CrmCommonCustomFieldValueVO doubleType = new CrmCommonCustomFieldValueVO("60539fa786a1801b172182849da04fbc", "123.45");
CrmCommonCustomFieldValueVO selectField = new CrmCommonCustomFieldValueVO("e88b441f0bf31d93bce64dc18762d81f", "1");
CrmCommonCustomFieldValueVO intType = new CrmCommonCustomFieldValueVO("31afb4319c55a3af9cf3bd34899c2735", "100000");
CrmCommonCustomFieldValueVO textField = new CrmCommonCustomFieldValueVO("ea4f60fdf4540b45fab6d3e664f2c691", "单行内容");
CrmCommonCustomFieldValueVO percentType = new CrmCommonCustomFieldValueVO("5f17acad9afbf1872630902dbab996e2", "50%");
// 添加到list
List<CrmCommonCustomFieldValueVO> customFields = new ArrayList<CrmCommonCustomFieldValueVO>();
customFields.add(textField);
customFields.add(textArea);
customFields.add(selectField);
customFields.add(phoneNumber);
customFields.add(dateTime);
customFields.add(intType);
customFields.add(doubleType);
customFields.add(percentType);
vo.setCustomFields(customFields);
// 设置自定义高级字段
List<CrmSeniorFieldVO> seniorFields = new ArrayList<CrmSeniorFieldVO>();
// 单行文本
seniorFields.add(new CrmSeniorFieldVO("fod9e4acf33e9147128fd085e7712a50e3", "这是高级字段单行类型字段"));
// 邮箱
seniorFields.add(new CrmSeniorFieldVO("foab338de2db0b449fa46cf375e9d87e3f", "123456789@qq.com"));
// 数字
seniorFields.add(new CrmSeniorFieldVO("fo57b9b1ae81ad492c879050330d5eb3d6", "233"));
// 电话
seniorFields.add(new CrmSeniorFieldVO("fo498bd7a5a3574807a9010882b70c334f", "020 12031200"));
// 手机
seniorFields.add(new CrmSeniorFieldVO("fo62e8daa9b10f41848a1e264f7de4819b", "13312031200"));
// 多行文本
seniorFields.add(new CrmSeniorFieldVO("fo61fd1ef6f36d4e5084f9a331b3d65b91", "这是高级字段多行文字类型\\n这是高级字段多行文字类型\\n"));
// 日期
seniorFields.add(new CrmSeniorFieldVO("fo645321f1c7b9415dba84974cc3f39202", "2019-12-03"));
// 时间
seniorFields.add(new CrmSeniorFieldVO("fo54af86e5f2494bb38a4de1a9282d0ad6", "12:00"));
// 日期时间
seniorFields.add(new CrmSeniorFieldVO("fob0adb4f6a7fe440782995cf6426f9ad3", "2019-11-11 11:11"));
// 单项选择
seniorFields.add(new CrmSeniorFieldVO("fo3674959396384edc8817651605913ccc", "选项1"));
// 多项选择
seniorFields.add(new CrmSeniorFieldVO("fod9e4acf33e9147128fd085e7712a50e3", "选项1,选项2"));
// 下拉框
seniorFields.add(new CrmSeniorFieldVO("foe99290cf57f84bfc814b70909a93fc4b", "选项1"));
// 评分
seniorFields.add(new CrmSeniorFieldVO("foe779eae3b38d436c8c72ded5324ba8b0", "3"));
// 地理位置
seniorFields.add(new CrmSeniorFieldVO("fo9982aebbdd9b423383e7182fbd57740c", "广东省广州市天河区员村一横路3号"));
// 省市区
seniorFields.add(new CrmSeniorFieldVO("fo6b8fdde86ec4472a972ec2b71edd7efa", "广东省:广州市:天河区"));
// 计算式 (当前设置 高级字段-数字 * 2)
seniorFields.add(new CrmSeniorFieldVO("fo521f8244ba3e4d6785602d4aee23a07d", "466"));
// 二级选项
seniorFields.add(new CrmSeniorFieldVO("fobb841af1252547b788d9c93c2baf27c3", "选项1:二级选项2"));
// 通信录成员
seniorFields.add(new CrmSeniorFieldVO("foc95fc853e5984552a77dc582a68e8962", "zhangsan,lisi"));
// 部门
seniorFields.add(new CrmSeniorFieldVO("foa19a6a39b6d3402a870fc7987ae40e13", "一级部门A->二级部门B,一级部门B->二级部门C->三级部门D"));
vo.setSeniorFields(seniorFields);
System.out.println(JSONUtil.stringify(vo));
CrmApi api = QwSdkUtil.getInter(CrmApi.class);
// 调用接口
ApiCrmInsertClientResultVO result = api.insertClientInfo(QwSdkUtil.getCacheToken(), vo);
System.out.println(JSONUtil.stringify(result));
{
"code":"0",
"data":
{
"clientId":"c5c17525-0ff2-4425-a57b-b075290f738f"
},
"desc":"成功"
}
| 参数 | 说明 | 备注 |
|
clientId |
新建的客户对应的ID |
|