fwq
2024-09-23 55334da20cff4dac840c320eda1d0ca53ba27eda
提交 | 用户 | age
5c5945 1 package com.hx.mp.util;
E 2
0c97aa 3 import com.hx.util.StringUtils;
F 4 import com.hz.util.http.HttpHzUtil;
5 import com.hz.util.http.dto.HttpHzResponse;
5c5945 6 import net.sf.json.JSONArray;
E 7 import net.sf.json.JSONException;
8 import net.sf.json.JSONObject;
9 import org.apache.commons.io.IOUtils;
10
11 import java.io.OutputStream;
12 import java.net.HttpURLConnection;
13 import java.net.URL;
0c97aa 14 import java.util.List;
5c5945 15
E 16 /**
17  * 企业微信客户工具
18  */
19 public class CorpMpClientUtil {
20
155ce4 21     /**
A 22      * 生成联系我按钮参数的链接(生成config_id)
5c5945 23      */
155ce4 24     public static final String CREATE_CONTACT_ID_URL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_contact_way?access_token=";
A 25     /**
26      * 获取企业客户详情链接
27      */
28     public static final String GET_CLIENT_DETAIL_URL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get";
29     /**
30      * 获取获取企业标签库链接
31      */
32     public static final String GET_CORP_TAG_LIST = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_corp_tag_list?access_token=";
33     /**
34      * 添加客户联系人标签
35      */
36     public static final String ADD_TAG = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_corp_tag?access_token=";
37     /**
38      * 编辑企业客户标签
39      */
40     public static final String EDIT_TAG = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/edit_corp_tag?access_token=";
41     /**
42      * 删除客户联系人标签
43      */
44     public static final String DEL_TAG = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/del_corp_tag?access_token=";
45     /**
46      * 客户关联企业微信的标签url
47      */
48     public static final String RELATION_TAG = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/mark_tag?access_token=";
5c5945 49
4a23ba 50     /**
A 51      * 获取员工客户列表url
52      */
53     public static final String EXTERNAL_CONTACT_LIST = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/list";
5c5945 54
155ce4 55     /**
6b479c 56      * 创建获客链接url
A 57      */
58     public static final String CUSTOMER_ACQUISITION_CREATE_LINK = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition/create_link?access_token=";
59
60     /**
61      * 获取获客客户列表
62      */
63     public static final String CUSTOMER_ACQUISITION_CUSTOMER_LIST = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition/customer?access_token=";
0c97aa 64
F 65     /**
66      * 获取配置过客户群管理的客户群列表
67      */
68     public static final String GROUP_CHAT_LIST = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/groupchat/list?access_token=";
69
70
71     /**
72      * 通过客户群ID,获取详情。包括群名、群成员列表、群成员入群时间、入群方式。(客户群是由具有客户群使用权限的成员创建的外部群)
73      */
74     public static final String GROUP_CHAT_DETAIL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/groupchat/get?access_token=";
a53802 75
A 76     /**
77      * 企业微信发送普通邮件
78      */
79     public static final String GROUP_SENT_EMAIL = "https://qyapi.weixin.qq.com/cgi-bin/exmail/app/compose_send?access_token=";
80
f8bd1c 81     /**
F 82      * 客户群「加入群聊」查看
83      */
84     public static final String GROUP_JOIN_WAY_SEE = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/groupchat/get_join_way?access_token=";
85     /**
86      * 客户群「加入群聊」新增
87      * 企业可调用此接口来生成并配置「加入群聊」的二维码或者小程序按钮
88      * 客户通过扫描二维码或点击小程序上的按钮,即可加入特定的客户群
89      */
90     public static final String GROUP_JOIN_WAY_ADD = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/groupchat/add_join_way?access_token=";
91     /**
92      * 客户群「加入群聊」修改
93      */
94     public static final String GROUP_JOIN_WAY_EDIT = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/groupchat/update_join_way?access_token=";
95     /**
96      * 客户群「加入群聊」删除
97      */
98     public static final String GROUP_JOIN_WAY_EDL= "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/groupchat/del_join_way?access_token=";
0c97aa 99
6b479c 100
A 101     /**
155ce4 102      * 生成企业成员联系我的id-单人
A 103      *
104      * @param accessToken 企业的accessToken
105      * @param userId      企业成员的userId
106      * @param state       企业自定义的state参数,用于区分不同的添加渠道,在调用“获取外部联系人详情”时会返回该参数值,不超过30个字符
107      * @param remark      联系方式的备注信息,用于助记,不超过30个字符
108      * @return 返回
109      */
110     public static JSONObject createContactId(String accessToken, String userId, String state, String remark) {
111
112         String configId = null;
113         JSONObject data = new JSONObject();
114         data.put("type", 1);
115         data.put("scene", 1);
116         data.put("state", state);
117         data.put("remark", remark);
118         JSONArray userIds = new JSONArray();
119         userIds.add(userId);
120         data.put("user", userIds);
121
122         //请求,返回格式
5c5945 123        /*{
E 124            "errcode": 0,
125                "errmsg": "ok",
126                "config_id":"42b34949e138eb6e027c123cba77fAAA"  
127        }*/
128
155ce4 129         return HttpURLUtil(CREATE_CONTACT_ID_URL + accessToken, data.toString());
A 130     }
5c5945 131
155ce4 132     /**
4a23ba 133      * 获取客户列表
A 134      * @param accessToken 企业的accessToken
135      * @param userId 企业成员的userId
136      * @return 返回
137      */
138     public static JSONObject getExternalContactList(String accessToken, String userId) {
139         return HttpURLUtil(EXTERNAL_CONTACT_LIST + "?access_token=" + accessToken + "&userid=" + userId, null);
140     }
141
142     /**
155ce4 143      * 获取企业客户详情信息
A 144      *
145      * @param accessToken    企业的accessToken
5c5945 146      * @param externalUserId 外部人员的userId
155ce4 147      * @return 返回
5c5945 148      */
155ce4 149     public static JSONObject getClientData(String accessToken, String externalUserId) {
A 150         return HttpURLUtil(GET_CLIENT_DETAIL_URL + "?access_token=" + accessToken + "&external_userid=" + externalUserId, null);
151     }
5c5945 152
155ce4 153     /**
A 154      * 企业可通过此接口获取企业客户标签详情
155      *
5c5945 156      * @param accessToken 企业的accessToken
155ce4 157      * @param tagId  标签id
A 158      * @param groupId 标签组id
159      * @return 返回
5c5945 160      */
155ce4 161     public static JSONObject getCorpTagList(String accessToken, JSONArray tagId, JSONArray groupId) {
A 162         JSONObject data = new JSONObject();
163         data.put("tag_id", tagId);
164         data.put("group_id", groupId);
165         return HttpURLUtil(GET_CORP_TAG_LIST + accessToken, data.toString());
166     }
5c5945 167
155ce4 168     /**
A 169      * 添加客户联系人标签,
170      * 如果要向指定的标签组下添加标签,需要填写group_id参数;如果要创建一个全新的标签组以及标签,
171      * 则需要通过group_name参数指定新标签组名称,如果填写的groupname已经存在,则会在此标签组下新建标签
172      *
173      * @param accessToken 企业的accessToken
174      * @param groupId     组id(组名称和组id必填一个)
175      * @param groupName   组名称 组名称和组id必填一个)
176      * @param groupOrder  组排序,不填默认企业微信生成规则
177      * @param tagArray    数组,格式:[{ "name": "TAG_NAME_1", "order": 1 }]
178      * @return 返回
179      */
180     public static JSONObject addTable(String accessToken, String groupId, String groupName, String groupOrder, JSONArray tagArray) {
181         JSONObject data = new JSONObject();
182         data.put("group_id", groupId);
183         data.put("group_name", groupName);
184         data.put("order", groupOrder);
185         data.put("tag", tagArray);
186         return HttpURLUtil(ADD_TAG + accessToken, data.toString());
187     }
188
189     /**
190      * 编辑企业客户标签,
191      * 注意:修改后的标签组不能和已有的标签组重名,标签也不能和同一标签组下的其他标签重名。
192      *
193      * @param accessToken 企业的accessToken
194      * @param id     标签或标签组的id
195      * @param name   新的标签或标签组名称,最长为30个字符
196      * @param order  标签/标签组的次序值。order值大的排序靠前。有效的值范围是[0, 2^32)
197      * @return 返回
198      */
199     public static JSONObject editTable(String accessToken, String id, String name, String order) {
200         JSONObject data = new JSONObject();
201         data.put("id", id);
202         data.put("name", name);
203         data.put("order", order);
204         return HttpURLUtil(EDIT_TAG + accessToken, data.toString());
205     }
206
207     /**
208      * 删除客户联系人标签
5c5945 209      * groupArr和tagArr不可同时为空。
E 210      * 如果一个标签组下所有的标签均被删除,则标签组会被自动删除。
155ce4 211      *
5c5945 212      * @param accessToken 企业的accessToken
155ce4 213      * @param groupArr    组id数组
A 214      * @param tagArr      标签id数组
215      * @return 返回
5c5945 216      */
155ce4 217     public static JSONObject delTable(String accessToken, JSONArray groupArr, JSONArray tagArr) {
A 218         JSONObject data = new JSONObject();
219         data.put("tag_id", tagArr);
220         data.put("group_id", groupArr);
221         return HttpURLUtil(DEL_TAG + accessToken, data.toString());
222     }
5c5945 223
E 224     /**
225      * 客户关联企业微信的标签
226      * 注意:请确保external_userid是userid的外部联系人。
227      * add_tag和remove_tag不可同时为空。
155ce4 228      *
A 229      * @param accessToken    企业的accessToken
230      * @param userId         企业成员的userid
5c5945 231      * @param externalUserId 外部联系人的id
155ce4 232      * @param addTag         新增的标签id(企业标签的id)数组
A 233      * @param removeTag      删除的标签id(企业标签的id)数组
234      * @return 返回
5c5945 235      */
155ce4 236     public static JSONObject relationTag(String accessToken, String userId, String externalUserId, JSONArray addTag, JSONArray removeTag) {
5c5945 237         JSONObject data = new JSONObject();
155ce4 238         data.put("userid", userId);
A 239         data.put("external_userid", externalUserId);
240         data.put("add_tag", addTag);
241         data.put("remove_tag", removeTag);
242         return HttpURLUtil(RELATION_TAG + accessToken, data.toString());
5c5945 243     }
E 244
155ce4 245     /**
A 246      * 请求http协议 获取信息工具
247      **/
5c5945 248     public static JSONObject HttpURLUtil(String url, String data) {
E 249         HttpURLConnection con = null;
250         URL u = null;
251         String wxMsgXml = null;
252         JSONObject obj = null;
253         try {
254             u = new URL(url);
255             con = (HttpURLConnection) u.openConnection();
256             con.setRequestMethod("POST");
257             con.setDoOutput(true);
258             con.setDoInput(true);
259             con.setUseCaches(false);
260             con.setReadTimeout(5000);
261             con.setRequestProperty("Charset", "UTF-8");
262             con.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
263
264             if (data != null) {
265                 OutputStream os = con.getOutputStream();
266                 os.write(data.getBytes("utf-8"));
267             }
268
269             if (con.getResponseCode() != 200)
270                 throw new RuntimeException("请求url失败");
271             // 读取返回内容
272             wxMsgXml = IOUtils.toString(con.getInputStream(), "utf-8");
273             obj = JSONObject.fromObject(wxMsgXml);
274             // //System.out.println("HttpURLUtil:"+wxMsgXml);
275         } catch (Exception e) {
276             e.printStackTrace();
277             obj = new JSONObject();
278             try {
279                 obj.put("status", 1);
280                 obj.put("errMsg", e.getMessage());
281             } catch (JSONException e1) {
282                 e1.printStackTrace();
283             }
284         } finally {
285             if (con != null) {
286                 con.disconnect();
287             }
288         }
289         return obj;
290     }
3f9abe 291
W 292     /**生成企业成员联系我的id-单人
293      * @param accessToken 企业的accessToken
294      * @param userId 企业成员的userId
295      * @param scene 场景,1-在小程序中联系,2-通过二维码联系
296      * @param state 企业自定义的state参数,用于区分不同的添加渠道,在调用“获取外部联系人详情”时会返回该参数值,不超过30个字符
297      * @param remark 联系方式的备注信息,用于助记,不超过30个字符
4a23ba 298      * @return 返回
3f9abe 299      */
W 300     public static JSONObject createContactId(String accessToken,String userId,int scene,String state,String remark){
301         String configId = null;
302         JSONObject data = new JSONObject();
303         data.put("type",1);
304         data.put("scene",scene);
305         data.put("state",state);
306         data.put("remark",remark);
307         JSONArray userIds = new JSONArray();
308         userIds.add(userId);
309         data.put("user",userIds);
310
311         //请求,返回格式
312        /*{
313            "errcode": 0,
314                "errmsg": "ok",
315                "config_id":"42b34949e138eb6e027c123cba77fAAA"  
316        }*/
317
318         return HttpURLUtil(CREATE_CONTACT_ID_URL+accessToken,data.toString());
319     }
6b479c 320
A 321     /**
322      * 创建获客链接
323      *
324      * @param accessToken 企业的accessToken
325      * @param linkName  链接名称
326      * @param userList 员工用户userId
327      * @return 返回
328      */
329     public static JSONObject createCustomerAcquisitionLink(String accessToken, String linkName, JSONArray userList) {
330         JSONObject data = new JSONObject();
331         data.put("link_name", linkName);
332         JSONObject subData = new JSONObject();
333         subData.accumulate("user_list", userList);
334         data.put("range", subData);
335         /** 返回数据
336          * {
337          *    "link_id":"LINK_ID",
338          *    "link_name":"获客链接1号",
339          *    "range":
340          *    {
341          *            "user_list":["zhangsan","lisi"],
342          *         "department_list":[2,3]
343          *    },
344          *    "skip_verify":true
345          * }
346          */
347         return HttpURLUtil(CUSTOMER_ACQUISITION_CREATE_LINK + accessToken, data.toString());
348     }
349
350     /**
351      * 获取获客客户列表
352      *
353      * @param accessToken 企业的accessToken
354      * @param linkId  链接id
ff57ac 355      * @param cursor  分页游标
6b479c 356      * @return 返回
A 357      */
ff57ac 358     public static JSONObject getCustomerAcquisitionCustomerList(String accessToken, String linkId, String cursor) {
6b479c 359         JSONObject data = new JSONObject();
A 360         data.put("link_id", linkId);
ff57ac 361         data.put("limit", 1000);
A 362         // 分页游标
363         if (!StringUtils.isEmpty(cursor)) {
364             data.put("cursor", cursor);
365         }
6b479c 366         /** 返回数据
A 367          * {
368          *     "errcode": 0,
369          *     "errmsg": "ok",
370          *     "customer_list":
371          *     [
372          *                {
373          *             "external_userid":"woAJ2GCAAAXtWyujaWJHDDGi0mACAAA",
374          *             "userid":"zhangsan",
375          *             "chat_status":0,
376          *             "state":"CHANNEL_A"
377          *        }
378          *     ],
379          *     "next_cursor":"CURSOR"
380          * }
381          */
382         return HttpURLUtil(CUSTOMER_ACQUISITION_CUSTOMER_LIST + accessToken, data.toString());
383     }
0c97aa 384
F 385
386     /**
387      * 该接口用于获取配置过客户群管理的客户群列表。
388      *
389      * @param accessToken  企业的accessToken
390      * @param statusFilter 客户群跟进状态过滤。0 - 所有列表(即不过滤) 1 - 离职待继承 2 - 离职继承中 3 - 离职继承完成
391      * @param userIdList   群主过滤 如果不填,表示获取应用可见范围内全部群主的数据可见范围人数超过1000人,为了防止数据包过大,会报错 81017 用户ID列表。最多100个
392      * @param cursor       分页下标
393      * @param limit        列表
394      * @return 返回
395      */
396     public static HttpHzResponse getGroupChatList(String accessToken, Integer statusFilter, List<String> userIdList, String cursor, Integer limit) {
397         JSONObject bodyData = new JSONObject();
398         bodyData.put("status_filter", statusFilter);
399         //分页下标
400         if (StringUtils.noNull(cursor)) {
401             bodyData.put("cursor", cursor);
402         }
403         //默认100条
404         if (limit == null) {
405             limit = 100;
406         }
407         bodyData.put("limit", limit);
408         //过滤
409         if (userIdList != null && userIdList.size() > 0) {
410             JSONObject filter = new JSONObject();
411             filter.put("userid_list", userIdList);
412             bodyData.put("owner_filter", filter);
413         }
414         return HttpHzUtil.HttpURLUtilJson(GROUP_CHAT_LIST + accessToken, bodyData.toString(), null, null, "GET", null);
415     }
416
417     /**
418      * 通过客户群ID,获取详情。包括群名、群成员列表、群成员入群时间、入群方式。(客户群是由具有客户群使用权限的成员创建的外部群)
419      *
420      * @param chatId   客户群ID
421      * @param needName 是否需要返回群成员的名字0-不返回;1-返回
422      */
423     public static HttpHzResponse getGroupChatDetail(String accessToken, String chatId, Integer needName) {
424         JSONObject bodyData = new JSONObject();
425         bodyData.put("chat_id", chatId);
426         if (needName == null) {
427             needName = 0;
428         }
429         bodyData.put("need_name", needName);
430         return HttpHzUtil.HttpURLUtilJson(GROUP_CHAT_DETAIL + accessToken, bodyData.toString(), null, null, "GET", null);
431     }
432
a53802 433     /**
A 434      * 企业微信发送普通邮件
435      * 接口地址: https://developer.work.weixin.qq.com/document/path/97445
436      * @param bodyData  参数
437      */
438     public static JSONObject sentEmail(String accessToken, JSONObject bodyData) {
439         return HttpURLUtil(GROUP_SENT_EMAIL + accessToken, bodyData.toString());
440     }
f8bd1c 441
F 442     /**
443      * 客户群「加入群聊」查看详情
444      * @param config_id 联系方式配置ID
445      * */
446     public static HttpHzResponse groupJoinSee(String accessToken, String config_id) {
447         JSONObject bodyData = new JSONObject();
448         bodyData.put("config_id", config_id);
449         return HttpHzUtil.HttpURLUtilJson(GROUP_JOIN_WAY_SEE + accessToken, bodyData.toString(), null, null, "POST", null);
450     }
451
452     /**
453      * 客户群「加入群聊」新增
454      * @param scene 场景。1 - 群的小程序插件, 2 - 群的二维码插件
455      * @param remark 联系方式的备注信息,用于助记,超过30个字符将被截断
456      * @param auto_create_room 当群满了后,是否自动新建群。0-否;1-是。 默认为1
457      * @param room_base_name 自动建群的群名前缀,当auto_create_room为1时有效。最长40个utf8字符
458      * @param room_base_id 自动建群的群起始序号,当auto_create_room为1时有效
459      * @param chat_id_list 使用该配置的客户群ID列表,最多支持5个
460      * */
461     public static HttpHzResponse groupJoinAdd(String accessToken, Integer scene, String remark
32a1dd 462             ,Integer auto_create_room,String room_base_name,Integer room_base_id,List<String> chat_id_list,String state) {
f8bd1c 463         JSONObject bodyData = new JSONObject();
F 464         bodyData.put("scene", scene);
465         bodyData.put("remark", remark);
466         bodyData.put("auto_create_room", auto_create_room);
467         bodyData.put("room_base_name", room_base_name);
468         bodyData.put("room_base_id", room_base_id);
469         bodyData.put("chat_id_list", chat_id_list);
470         bodyData.put("state", state);
471         return HttpHzUtil.HttpURLUtilJson(GROUP_JOIN_WAY_ADD + accessToken, bodyData.toString(), null, null, "POST", null);
472     }
473
474     /**
475      * 客户群「加入群聊」修改
476      * @param config_id 联系方式配置ID
477      * @param scene 场景。1 - 群的小程序插件, 2 - 群的二维码插件
478      * @param remark 联系方式的备注信息,用于助记,超过30个字符将被截断
479      * @param auto_create_room 当群满了后,是否自动新建群。0-否;1-是。 默认为1
480      * @param room_base_name 自动建群的群名前缀,当auto_create_room为1时有效。最长40个utf8字符
481      * @param room_base_id 自动建群的群起始序号,当auto_create_room为1时有效
482      * @param chat_id_list 使用该配置的客户群ID列表,最多支持5个
483      * */
484     public static HttpHzResponse groupJoinEdit(String accessToken,String config_id, Integer scene, String remark
32a1dd 485             ,Integer auto_create_room,String room_base_name,Integer room_base_id,List<String> chat_id_list,String state) {
f8bd1c 486         JSONObject bodyData = new JSONObject();
F 487         bodyData.put("config_id", config_id);
488         bodyData.put("scene", scene);
489         bodyData.put("remark", remark);
490         bodyData.put("auto_create_room", auto_create_room);
491         bodyData.put("room_base_name", room_base_name);
492         bodyData.put("room_base_id", room_base_id);
493         bodyData.put("chat_id_list", chat_id_list);
494         bodyData.put("state", state);
495         return HttpHzUtil.HttpURLUtilJson(GROUP_JOIN_WAY_EDIT + accessToken, bodyData.toString(), null, null, "POST", null);
496     }
497
498     /**
499      * 客户群「加入群聊」删除
500      * @param config_id 联系方式配置ID
501      * */
502     public static HttpHzResponse groupJoinDel(String accessToken, String config_id) {
503         JSONObject bodyData = new JSONObject();
504         bodyData.put("config_id", config_id);
505         return HttpHzUtil.HttpURLUtilJson(GROUP_JOIN_WAY_EDL + accessToken, bodyData.toString(), null, null, "POST", null);
506     }
507
508
509
5c5945 510 }