企业微信联系我接口优化

wangrenhuang

2022-10-21 3f9abe5f0c01b950a70e3f29aab76b1d6f686e53

 src/main/java/com/hx/mp/util/CorpMpClientUtil.java

@@ -8,121 +8,181 @@
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.text.MessageFormat;

/**
 * 企业微信客户工具
 */
public class CorpMpClientUtil {

   /**生成联系我按钮参数的链接（生成config_id）*/
   public static final String CREATE_CONTACT_ID_URL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_contact_way?access_token=";
   /**获取企业客户详情链接*/
   public static final String GET_CLIENT_DETAIL_URL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get";
   /**添加客户联系人标签*/
   public static final String ADD_TAG = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_corp_tag?access_token=";
   /**删除客户联系人标签*/
   public static final String DEL_TAG = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/del_corp_tag?access_token=";
   /**客户关联企业微信的标签url*/
   public static final String RELATION_TAG = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/mark_tag?access_token=";


    /**生成企业成员联系我的id-单人
     * @param accessToken 企业的accessToken
     * @param userId 企业成员的userId
     * @param state 企业自定义的state参数，用于区分不同的添加渠道，在调用“获取外部联系人详情”时会返回该参数值，不超过30个字符
     * @param remark 联系方式的备注信息，用于助记，不超过30个字符
     * @return
    /**
     * 生成联系我按钮参数的链接（生成config_id）
     */
   public static JSONObject createContactId(String accessToken,String userId,String state,String remark){
    public static final String CREATE_CONTACT_ID_URL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_contact_way?access_token=";
    /**
     * 获取企业客户详情链接
     */
    public static final String GET_CLIENT_DETAIL_URL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get";
    /**
     * 获取获取企业标签库链接
     */
    public static final String GET_CORP_TAG_LIST = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_corp_tag_list?access_token=";
    /**
     * 添加客户联系人标签
     */
    public static final String ADD_TAG = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_corp_tag?access_token=";
    /**
     * 编辑企业客户标签
     */
    public static final String EDIT_TAG = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/edit_corp_tag?access_token=";
    /**
     * 删除客户联系人标签
     */
    public static final String DEL_TAG = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/del_corp_tag?access_token=";
    /**
     * 客户关联企业微信的标签url
     */
    public static final String RELATION_TAG = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/mark_tag?access_token=";

       String configId = null;
       JSONObject data = new JSONObject();
       data.put("type",1);
       data.put("scene",1);
       data.put("state",state);
       data.put("remark",remark);
       JSONArray userIds = new JSONArray();
       userIds.add(userId);
       data.put("user",userIds);

       //请求，返回格式
    /**
     * 生成企业成员联系我的id-单人
     *
     * @param accessToken 企业的accessToken
     * @param userId      企业成员的userId
     * @param state       企业自定义的state参数，用于区分不同的添加渠道，在调用“获取外部联系人详情”时会返回该参数值，不超过30个字符
     * @param remark      联系方式的备注信息，用于助记，不超过30个字符
     * @return 返回
     */
    public static JSONObject createContactId(String accessToken, String userId, String state, String remark) {

        String configId = null;
        JSONObject data = new JSONObject();
        data.put("type", 1);
        data.put("scene", 1);
        data.put("state", state);
        data.put("remark", remark);
        JSONArray userIds = new JSONArray();
        userIds.add(userId);
        data.put("user", userIds);

        //请求，返回格式
       /*{
           "errcode": 0,
               "errmsg": "ok",
               "config_id":"42b34949e138eb6e027c123cba77fAAA"　　
       }*/

       return HttpURLUtil(CREATE_CONTACT_ID_URL+accessToken,data.toString());
   }
        return HttpURLUtil(CREATE_CONTACT_ID_URL + accessToken, data.toString());
    }

    /**获取企业客户详情信息
     * @param accessToken 企业的accessToken
    /**
     * 获取企业客户详情信息
     *
     * @param accessToken    企业的accessToken
     * @param externalUserId 外部人员的userId
     * @return
     * @return 返回
     */
   public static JSONObject getClientData(String accessToken,String externalUserId){
    public static JSONObject getClientData(String accessToken, String externalUserId) {

       return HttpURLUtil(GET_CLIENT_DETAIL_URL+"?access_token="+accessToken+"&external_userid="+externalUserId,null);
   }
        return HttpURLUtil(GET_CLIENT_DETAIL_URL + "?access_token=" + accessToken + "&external_userid=" + externalUserId, null);
    }

    /** 添加客户联系人标签，
     *如果要向指定的标签组下添加标签，需要填写group_id参数；如果要创建一个全新的标签组以及标签，
     *则需要通过group_name参数指定新标签组名称，如果填写的groupname已经存在，则会在此标签组下新建标签
    /**
     * 企业可通过此接口获取企业客户标签详情
     *
     * @param accessToken 企业的accessToken
     * @param groupId 组id（组名称和组id必填一个）
     * @param groupName 组名称 组名称和组id必填一个）
     * @param groupOrder 组排序，不填默认企业微信生成规则
     * @param tagArray 数组，格式：[{ "name": "TAG_NAME_1", "order": 1 }]
     * @return
     * @param tagId  标签id
     * @param groupId 标签组id
     * @return 返回
     */
   public static JSONObject addTable(String accessToken,String groupId,String groupName,String groupOrder,JSONArray tagArray){
       JSONObject data = new JSONObject();
       data.put("group_id",groupId);
       data.put("group_name",groupName);
       data.put("order",groupOrder);
       data.put("tag",tagArray);
       return HttpURLUtil(ADD_TAG+accessToken,data.toString());
   }
    public static JSONObject getCorpTagList(String accessToken, JSONArray tagId, JSONArray groupId) {
        JSONObject data = new JSONObject();
        data.put("tag_id", tagId);
        data.put("group_id", groupId);
        return HttpURLUtil(GET_CORP_TAG_LIST + accessToken, data.toString());
    }

    /**删除客户联系人标签
    /**
     * 添加客户联系人标签，
     * 如果要向指定的标签组下添加标签，需要填写group_id参数；如果要创建一个全新的标签组以及标签，
     * 则需要通过group_name参数指定新标签组名称，如果填写的groupname已经存在，则会在此标签组下新建标签
     *
     * @param accessToken 企业的accessToken
     * @param groupId     组id（组名称和组id必填一个）
     * @param groupName   组名称 组名称和组id必填一个）
     * @param groupOrder  组排序，不填默认企业微信生成规则
     * @param tagArray    数组，格式：[{ "name": "TAG_NAME_1", "order": 1 }]
     * @return 返回
     */
    public static JSONObject addTable(String accessToken, String groupId, String groupName, String groupOrder, JSONArray tagArray) {
        JSONObject data = new JSONObject();
        data.put("group_id", groupId);
        data.put("group_name", groupName);
        data.put("order", groupOrder);
        data.put("tag", tagArray);
        return HttpURLUtil(ADD_TAG + accessToken, data.toString());
    }

    /**
     * 编辑企业客户标签，
     * 注意:修改后的标签组不能和已有的标签组重名，标签也不能和同一标签组下的其他标签重名。
     *
     * @param accessToken 企业的accessToken
     * @param id     标签或标签组的id
     * @param name   新的标签或标签组名称，最长为30个字符
     * @param order  标签/标签组的次序值。order值大的排序靠前。有效的值范围是[0, 2^32)
     * @return 返回
     */
    public static JSONObject editTable(String accessToken, String id, String name, String order) {
        JSONObject data = new JSONObject();
        data.put("id", id);
        data.put("name", name);
        data.put("order", order);
        return HttpURLUtil(EDIT_TAG + accessToken, data.toString());
    }

    /**
     * 删除客户联系人标签
     * groupArr和tagArr不可同时为空。
     * 如果一个标签组下所有的标签均被删除，则标签组会被自动删除。
     *
     * @param accessToken 企业的accessToken
     * @param groupArr 组id数组
     * @param tagArr 标签id数组
     * @return
     * @param groupArr    组id数组
     * @param tagArr      标签id数组
     * @return 返回
     */
   public static JSONObject delTable(String accessToken,JSONArray groupArr,String tagArr){
       JSONObject data = new JSONObject();
       data.put("tag_id",tagArr);
       data.put("group_id",groupArr);
       return HttpURLUtil(DEL_TAG+accessToken,data.toString());
   }
    public static JSONObject delTable(String accessToken, JSONArray groupArr, JSONArray tagArr) {
        JSONObject data = new JSONObject();
        data.put("tag_id", tagArr);
        data.put("group_id", groupArr);
        return HttpURLUtil(DEL_TAG + accessToken, data.toString());
    }

    /**
     * 客户关联企业微信的标签
     * 注意：请确保external_userid是userid的外部联系人。
     * add_tag和remove_tag不可同时为空。
     * @param accessToken 企业的accessToken
     * @param userId 企业成员的userid
     *
     * @param accessToken    企业的accessToken
     * @param userId         企业成员的userid
     * @param externalUserId 外部联系人的id
     * @param addTag 新增的标签id（企业标签的id）数组
     * @param removeTag 删除的标签id（企业标签的id）数组
     * @return
     * @param addTag         新增的标签id（企业标签的id）数组
     * @param removeTag      删除的标签id（企业标签的id）数组
     * @return 返回
     */
    public static JSONObject relationTag(String accessToken,String userId,String externalUserId
            ,JSONArray addTag,JSONArray removeTag){
    public static JSONObject relationTag(String accessToken, String userId, String externalUserId, JSONArray addTag, JSONArray removeTag) {
        JSONObject data = new JSONObject();
        data.put("userid",userId);
        data.put("external_userid",externalUserId);
        data.put("add_tag",addTag);
        data.put("remove_tag",removeTag);
        return HttpURLUtil(RELATION_TAG+accessToken,data.toString());
        data.put("userid", userId);
        data.put("external_userid", externalUserId);
        data.put("add_tag", addTag);
        data.put("remove_tag", removeTag);
        return HttpURLUtil(RELATION_TAG + accessToken, data.toString());
    }


    /** 请求http协议 获取信息工具 **/
    /**
     * 请求http协议 获取信息工具
     **/
    public static JSONObject HttpURLUtil(String url, String data) {
        HttpURLConnection con = null;
        URL u = null;
@@ -166,4 +226,34 @@
        }
        return obj;
    }

    /**生成企业成员联系我的id-单人
     * @param accessToken 企业的accessToken
     * @param userId 企业成员的userId
     * @param scene 场景，1-在小程序中联系，2-通过二维码联系
     * @param state 企业自定义的state参数，用于区分不同的添加渠道，在调用“获取外部联系人详情”时会返回该参数值，不超过30个字符
     * @param remark 联系方式的备注信息，用于助记，不超过30个字符
     * @return
     */
    public static JSONObject createContactId(String accessToken,String userId,int scene,String state,String remark){

        String configId = null;
        JSONObject data = new JSONObject();
        data.put("type",1);
        data.put("scene",scene);
        data.put("state",state);
        data.put("remark",remark);
        JSONArray userIds = new JSONArray();
        userIds.add(userId);
        data.put("user",userIds);

        //请求，返回格式
       /*{
           "errcode": 0,
               "errmsg": "ok",
               "config_id":"42b34949e138eb6e027c123cba77fAAA"　　
       }*/

        return HttpURLUtil(CREATE_CONTACT_ID_URL+accessToken,data.toString());
    }
}