功能说明:新增一个CRM联系人
请求方式:POST(HTTPS)
请求地址:https://qwif.do1.com.cn/qwcgi/api/crm/contacts/addContacts.do?token=token&corpId=corpId
参数:data { "clientId":"000527451e2b4157a93fd8cd2a687d93", "contactsName":"新增CRM联系人", "mobile":"13430215698", "telephone":"13333216654", "position":"经理", "email":"12@qq.com", "birthday":"2018-12-12", "schoolName":"大学", "hobby":"打球,看电影", "remark":"备注内容", "ccPersonIds":"dc924ee1515cef2e3c0f8a6eff8ce5e2", "relativePersonIds":"dc924ee1515cef2e3c0f8a6eff8ce5e2,2a442250fe1d4c178a7e22e1e3794317", "submitType":"1", "optionMap":{ "日期选择":"2019-01-16 12:12", "数值整数":12, "数值小数":12.12, "数值百分数":"12%", "单行文本":"我是单行文本内容", "多行文本":"我是多行文本内容", "下拉菜单":"选项1", "联系方式":13430216955 }, "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仅做展示用,实际调用不需要传。
参数 | 说明 | 类型 | 是否必须 | 备注 |
---|---|---|---|---|
clientId | CRM联系人关联的客户id | String | 是 | |
contactsName | CRM联系人名称 | String | 是 | |
mobile | 联系电话 | String | 否 | |
telephone |
座机 | String | 否 |
|
position | 职位 | String | 否 | 50字以内 |
邮箱 | String | 否 | 50字以内 | |
birthday | 生日 | String | 否 | 格式为yyyy-MM-dd |
schoolName | 学校 | String | 否 | 100字以内 |
hobby | 兴趣 | String | 否 | 500字以内 |
remark | 备注 | String | 否 | 2000字以内 |
ccPersonIds | 负责人id | String | 是 | 多个负责人用英文逗号分隔 |
relativePersonIds | 相关人id | String | 否 | 多个相关人用英文逗号分隔 |
submitType | 消息发送类型 | String | 否 | 默认发送给负责人, 1:为发送新建消息给CRM联系人的相关人 |
optionMap | 自定义字段按键值对 | String | 否 | "字段名称":"字段值",其中日期类型的格式为:yyyy_MM-dd HH:mm,下拉菜单类型的值为选项值 |
seniorFields | 自定义高级字段 | JSON | 否 |
|
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 |
// 创建请求参数 CrmContactsReqVO vo = new CrmContactsReqVO(); //客户id vo.setClientId("000527451e2b4157a93fd8cd2a687d93"); //联系人名称 vo.setContactsName("新增CRM0联系人"); //生日 vo.setBirthday("1990-10-12"); //负责人id vo.setCcPersonIds("dc924ee1515cef2e3c0f8a6eff8ce5e2"); //邮箱 vo.setEmail("123@163.com"); //兴趣 vo.setHobby("看电影"); //联系电话 vo.setMobile("13436958425"); //座机号码 vo.setMobile("13436958425"); //职位 vo.setPosition("经理"); //备注 vo.setRemark("备注内容"); //相关人id vo.setRelativePersonIds("dc924ee1515cef2e3c0f8a6eff8ce5e2,2a442250fe1d4c178a7e22e1e3794317"); //学校 vo.setSchoolName("XXX"); //消息类型 vo.setSubmitType("1"); //自定义字段键值对 Map<String, Object> optionMap = new HashMap<String, Object>(); optionMap.put("数值小数",12.12); optionMap.put("多行文本","多行文本内容"); optionMap.put("下拉菜单","选项1"); optionMap.put("联系方式","13430524955"); optionMap.put("日期类型","2018-01-12"); vo.setOptionMap(optionMap); // 设置自定义高级字段 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); // 调用接口 System.out.println(QwSdkUtil.getCacheToken()); ApiCrmContactsResultVO crmContactsRepVO = api.addContacts(QwSdkUtil.getCacheToken(), vo); System.out.println(JSONUtil.stringify(crmContactsRepVO));
{ "code":"0", "data":{ "contactsInfo":{ "birthday":"2018-12-12", "ccPersons":{ "李志斌":"dc924ee1515cef2e3c0f8a6eff8ce5e2" }, "clientId":"000527451e2b4157a93fd8cd2a687d93", "clientName":"CRM客户名称", "contactsName":"新增CRM联系人", "email":"12@qq.com", "hobby":"打球,看电影", "id":"741dbc6cfd3046a08c8190f5ffc01fe4", "mobile":"13430215698", "optionMap":{ "下拉菜单":"选项1", "单行文本":"我是单行文本内容", "多行文本":"我是多行文本内容", "数值小数":12.12, "数值整数":12, "数值百分数":"12%", "日期选择":"2019-01-16 12:12", "联系方式":13430216955 }, "pinyin":"xinzengCRMlianxiren", "position":"经理", "relativePersons":{ "李志斌":"dc924ee1515cef2e3c0f8a6eff8ce5e2", "罗博文11":"2a442250fe1d4c178a7e22e1e3794317" }, "remark":"备注内容", "schoolName":"大学", "submitType":"1", "telephone":"13366325458", "seniorFields":[ { "fieldName":"高级字段-单行文字", "fieldValue":"这是高级字段单行类型字段" }, { "fieldName":"高级字段-邮箱", "fieldValue":"123456789@qq.com" }, { "fieldName":"高级字段-数字", "fieldValue":"233" }, { "fieldName":"高级字段-电话", "fieldValue":"020 12031200" }, { "fieldName":"高级字段-手机", "fieldValue":"13312031200" }, { "fieldName":"高级字段-多行文字", "fieldValue":"这是高级字段多行文字类型\n这是高级字段多行文字类型\n" }, { "fieldName":"高级字段-日期", "fieldValue":"2019-12-03" }, { "fieldName":"高级字段-时间", "fieldValue":"18:00" }, { "fieldName":"高级字段-日期时间", "fieldValue":"2019-11-11 11:11" }, { "fieldName":"高级字段-单项选择", "fieldValue":"选项1" }, { "fieldName":"高级字段-多项选择", "fieldValue":"选项1,选项2" }, { "fieldName":"高级字段-下拉框", "fieldValue":"选项1" }, { "fieldName":"高级字段-评分", "fieldValue":"3" }, { "fieldName":"高级字段-地理位置", "fieldValue":"广东省广州市天河区员村一横路3号" }, { "fieldName":"高级字段-省市区", "fieldValue":"广东省:广州市:天河区" }, { "fieldName":"高级字段-计算式", "fieldValue":"466" }, { "fieldName":"高级字段-两级下拉框", "fieldValue":"选项1:二级选项2" }, { "fieldName":"高级字段-通讯录成员", "fieldValue":"zhangsan,lisi" }, { "fieldName":"高级字段-部门", "fieldValue":"一级部门A->二级部门B,一级部门B->二级部门C->三级部门D" } ] } }, "desc":"成功" }
contactsInfo参数 | 说明 | 备注 |
---|---|---|
birthday | 生日 |
|
ccPersons | 负责人 | "负责人名称":"负责人id" |
clientId | CRM联系人关联的客户id | |
clientName | CRM联系人关联的客户名称 | |
contactsName | CRM联系人名称 | |
邮箱 | ||
hobby | 兴趣 | |
id | CRM联系人id | |
mobile | 联系电话 | |
optionMap | 自定义字段按键值对 | 字段名称:"字段值" |
pinyin | CRM联系人名称拼音 | |
position | 职位 | |
relativePersons | 相关人 | "相关人名称":"相关人id" |
remark | 备注 | |
schoolName | 学校 | |
submitType | 消息发送类型 | 默认发送给负责人, 1:为发送新建消息给CRM联系人的相关人 |
telephone | 座机号码 |
|
seniorFields | 自定义高级字段 |
|
seniorField
参数 | 说明 | 类型 |
---|---|---|
fieldName |
自定义高级字段名 |
String |
fieldValue |
fieldValue |
String |