微信公众平台 获取用户基本信息(UnionID机制)

来源:互联网 发布:如何注册淘宝账号 编辑:程序博客网 时间:2024/05/16 09:38

注:内容摘抄于微信公众平台技术文档

微信公众平台官方文档:微信公众平台技术文档

在关注者与公众号产生消息交互后,公众号可获得关注者的OpenID(加密后的微信号,每个用户对每个公众号的OpenID是唯一的。对于不同公众号,同一用户的openid不同)。公众号可通过本接口来根据OpenID获取用户基本信息,包括昵称、头像、性别、所在城市、语言和关注时间。

请注意,如果开发者有在多个公众号,或在公众号、移动应用之间统一用户帐号的需求,需要前往微信开放平台(open.weixin.qq.com)绑定公众号后,才可利用UnionID机制来满足上述需求。

UnionID机制说明:
开发者可通过OpenID来获取用户基本信息。特别需要注意的是,如果开发者拥有多个移动应用、网站应用和公众帐号,可通过获取用户基本信息中的unionid来区分用户的唯一性,因为只要是同一个微信开放平台帐号下的移动应用、网站应用和公众帐号,用户的unionid是唯一的。换句话说,同一用户,对同一个微信开放平台下的不同应用,unionid是相同的。

一、获取用户基本信息(包括UnionID机制)

开发者可通过OpenID来获取用户基本信息。请使用https协议。

1:接口调用请求说明

http请求方式: GET

https://api.weixin.qq.com/cgi-bin/user/info?access_token=ACCESS_TOKEN&openid=OPENID&lang=zh_CN 

2:参数说明

参数 是否必须 说明 access_token 是 调用接口凭证 openid 是 普通用户的标识,对当前公众号唯一 lang 否 返回国家地区语言版本,zh_CN 简体,zh_TW 繁体,en 英语

3:java接口开发

(1)返回参数对象信息

import java.util.List;/** * 类描述: 微信用户的基本信息 */public class WeixinUserInfo {    // 用户的标识    private String openid;    // 关注状态(1是关注,0是未关注),未关注时获取不到其余信息    private int subscribe;    // 用户关注时间,为时间戳。如果用户曾多次关注,则取最后关注时间    private String subscribe_time;    // 昵称    private String nickname;    // 用户的性别(1是男性,2是女性,0是未知)    private int sex;    // 用户所在国家    private String country;    // 用户所在省份    private String province;    // 用户所在城市    private String city;    // 用户的语言,简体中文为zh_CN    private String language;    // 用户头像    private String headimgurl;    // 只有在用户将公众号绑定到微信开放平台帐号后,才会出现该字段。    private String unionid;    // 公众号运营者对粉丝的备注,公众号运营者可在微信公众平台用户管理界面对粉丝添加备注    private String remark;    // 用户所在的分组ID(兼容旧的用户分组接口)    private int groupid;     // 用户被打上的标签ID列表    private List<Integer> tagid_list;     // 错误编码    private int errcode;    // 错误提示    private String errmsg="ok";    public String getOpenid() {        return openid;    }    public void setOpenid(String openid) {        this.openid = openid;    }    public int getSubscribe() {        return subscribe;    }    public void setSubscribe(int subscribe) {        this.subscribe = subscribe;    }    public String getSubscribe_time() {        return subscribe_time;    }    public void setSubscribe_time(String subscribe_time) {        this.subscribe_time = subscribe_time;    }    public String getNickname() {        return nickname;    }    public void setNickname(String nickname) {        this.nickname = nickname;    }    public int getSex() {        return sex;    }    public void setSex(int sex) {        this.sex = sex;    }    public String getCountry() {        return country;    }    public void setCountry(String country) {        this.country = country;    }    public String getProvince() {        return province;    }    public void setProvince(String province) {        this.province = province;    }    public String getCity() {        return city;    }    public void setCity(String city) {        this.city = city;    }    public String getLanguage() {        return language;    }    public void setLanguage(String language) {        this.language = language;    }    public String getHeadimgurl() {        return headimgurl;    }    public void setHeadimgurl(String headimgurl) {        this.headimgurl = headimgurl;    }    public int getErrcode() {        return errcode;    }    public void setErrcode(int errcode) {        this.errcode = errcode;    }    public String getErrmsg() {        return errmsg;    }    public void setErrmsg(String errmsg) {        this.errmsg = errmsg;    }    public String getUnionid() {        return unionid;    }    public void setUnionid(String unionid) {        this.unionid = unionid;    }    public String getRemark() {        return remark;    }    public void setRemark(String remark) {        this.remark = remark;    }    public int getGroupid() {        return groupid;    }    public void setGroupid(int groupid) {        this.groupid = groupid;    }    public List<Integer> getTagid_list() {        return tagid_list;    }    public void setTagid_list(List<Integer> tagid_list) {        this.tagid_list = tagid_list;    }}

(2)请求参数方法

   /**     * 获取用户信息     * @param accessToken 接口访问凭证     * @param openId 用户标识     * @return WeixinUserInfo     */    public static WeixinUserInfo getUserInfo(String accessToken, String openId) {        WeixinUserInfo weixinUserInfo = null;        // 拼接请求地址        String requestUrl = "https://api.weixin.qq.com/cgi-bin/user/info?access_token=ACCESS_TOKEN&openid=OPENID";        requestUrl = requestUrl.replace("ACCESS_TOKEN", accessToken).replace("OPENID", openId);        // 获取用户信息        JSONObject jsonObject = CommonUtil.httpsRequest(requestUrl, "GET", null);        if (null != jsonObject) {            try {                weixinUserInfo = new WeixinUserInfo();                // 用户的标识                weixinUserInfo.setOpenId(jsonObject.getString("openid"));                // 关注状态(1是关注,0是未关注),未关注时获取不到其余信息                weixinUserInfo.setSubscribe(jsonObject.getInt("subscribe"));                // 用户关注时间                weixinUserInfo.setSubscribeTime(jsonObject.getString("subscribe_time"));                // 昵称                weixinUserInfo.setNickname(jsonObject.getString("nickname"));                // 用户的性别(1是男性,2是女性,0是未知)                weixinUserInfo.setSex(jsonObject.getInt("sex"));                // 用户所在国家                weixinUserInfo.setCountry(jsonObject.getString("country"));                // 用户所在省份                weixinUserInfo.setProvince(jsonObject.getString("province"));                // 用户所在城市                weixinUserInfo.setCity(jsonObject.getString("city"));                // 用户的语言,简体中文为zh_CN                weixinUserInfo.setLanguage(jsonObject.getString("language"));                // 用户头像                weixinUserInfo.setHeadImgUrl(jsonObject.getString("headimgurl"));            } catch (Exception e) {                if (0 == weixinUserInfo.getSubscribe()) {                    log.error("用户{}已取消关注", weixinUserInfo.getOpenId());                } else {                    int errorCode = jsonObject.getInt("errcode");                    String errorMsg = jsonObject.getString("errmsg");                    log.error("获取用户信息失败 errcode:{} errmsg:{}", errorCode, errorMsg);                }            }        }        return weixinUserInfo;    }

(3)http请求工具类

   /**     * 发送https请求     * @param requestUrl 请求地址     * @param requestMethod 请求方式(GET、POST)     * @param outputStr 提交的数据     * @return JSONObject(通过JSONObject.get(key)的方式获取json对象的属性值)     */    public static JSONObject httpsRequest(String requestUrl, String requestMethod, String outputStr) {        JSONObject jsonObject = null;        try {            // 创建SSLContext对象,并使用我们指定的信任管理器初始化            TrustManager[] tm = { new MyX509TrustManager() };            SSLContext sslContext = SSLContext.getInstance("SSL", "SunJSSE");            sslContext.init(null, tm, new java.security.SecureRandom());            // 从上述SSLContext对象中得到SSLSocketFactory对象            SSLSocketFactory ssf = sslContext.getSocketFactory();            URL url = new URL(requestUrl);            HttpsURLConnection conn = (HttpsURLConnection) url.openConnection();            conn.setSSLSocketFactory(ssf);            conn.setDoOutput(true);            conn.setDoInput(true);            conn.setUseCaches(false);            // 设置请求方式(GET/POST)            conn.setRequestMethod(requestMethod);            // 当outputStr不为null时向输出流写数据            if (null != outputStr) {                OutputStream outputStream = conn.getOutputStream();                // 注意编码格式                outputStream.write(outputStr.getBytes("UTF-8"));                outputStream.close();            }            // 从输入流读取返回内容            InputStream inputStream = conn.getInputStream();            InputStreamReader inputStreamReader = new InputStreamReader(inputStream, "utf-8");            BufferedReader bufferedReader = new BufferedReader(inputStreamReader);            String str = null;            StringBuffer buffer = new StringBuffer();            while ((str = bufferedReader.readLine()) != null) {                buffer.append(str);            }            // 释放资源            bufferedReader.close();            inputStreamReader.close();            inputStream.close();            inputStream = null;            conn.disconnect();            jsonObject = JSONObject.fromObject(buffer.toString());        } catch (ConnectException ce) {            log.error("连接超时:{}", ce);        } catch (Exception e) {            log.error("https请求异常:{}", e);        }        return jsonObject;    }

(4)信任管理器工具类

/** * 类名: MyX509TrustManager.java</br>  * 描述: 信任管理器</br>  */public class MyX509TrustManager implements X509TrustManager {    // 检查客户端证书    public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException {    }    // 检查服务器端证书    public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException {    }    // 返回受信任的X509证书数组    public X509Certificate[] getAcceptedIssuers() {        return null;    }}

4:返回说明

正常情况下,微信会返回下述JSON数据包给公众号:

{   "subscribe": 1,    "openid": "o6_bmjrPTlm6_2sgVt7hMZOPfL2M",    "nickname": "Band",    "sex": 1,    "language": "zh_CN",    "city": "广州",    "province": "广东",    "country": "中国",    "headimgurl":  "http://wx.qlogo.cn/mmopen/g3MonUZtNHkdmzicIlibx6iaFqAc56vxLSUfpb6n5WKSYVY0ChQKkiaJSgQ1dZuTOgvLLrhJbERQQ4eMsv84eavHiaiceqxibJxCfHe/0",  "subscribe_time": 1382694957,  "unionid": " o6_bmasdasdsad6_2sgVt7hMZOPfL"  "remark": "",  "groupid": 0,  "tagid_list":[128,2]}

参数说明

参数 说明 subscribe 用户是否订阅该公众号标识,值为0时,代表此用户没有关注该公众号,拉取不到其余信息。 openid 用户的标识,对当前公众号唯一 nickname 用户的昵称 sex 用户的性别,值为1时是男性,值为2时是女性,值为0时是未知 city 用户所在城市 country 用户所在国家 province 用户所在省份 language 用户的语言,简体中文为zh_CN headimgurl 用户头像,最后一个数值代表正方形头像大小(有0、46、64、96、132数值可选,0代表640*640正方形头像),用户没有头像时该项为空。若用户更换头像,原有头像URL将失效。 subscribe_time 用户关注时间,为时间戳。如果用户曾多次关注,则取最后关注时间 unionid 只有在用户将公众号绑定到微信开放平台帐号后,才会出现该字段。 remark 公众号运营者对粉丝的备注,公众号运营者可在微信公众平台用户管理界面对粉丝添加备注 groupid 用户所在的分组ID(兼容旧的用户分组接口) tagid_list 用户被打上的标签ID列表


错误时微信会返回错误码等信息,JSON数据包示例如下(该示例为AppID无效错误):

{"errcode":40013,"errmsg":"invalid appid"}

二、批量获取用户基本信息

开发者可通过该接口来批量获取用户基本信息。最多支持一次拉取100条。

1:接口调用请求说明

(1)http请求方式: POST

https://api.weixin.qq.com/cgi-bin/user/info/batchget?access_token=ACCESS_TOKEN

(2)POST数据示例

{   "user_list": [       {           "openid": "otvxTs4dckWG7imySrJd6jSi0CWE",            "lang": "zh_CN"       },        {           "openid": "otvxTs_JZ6SEiP0imdhpi50fuSZg",            "lang": "zh_CN"       }   ]}

2:参数说明

参数 是否必须 说明 openid 是 用户的标识,对当前公众号唯一 lang 否 国家地区语言版本,zh_CN 简体,zh_TW 繁体,en 英语,默认为zh-CN

3:返回说明

正常情况下,微信会返回下述JSON数据包给公众号(示例中为一次性拉取了2个openid的用户基本信息,第一个是已关注的,第二个是未关注的):

{  "user_info_list": [      {          "subscribe": 1,           "openid": "otvxTs4dckWG7imySrJd6jSi0CWE",           "nickname": "iWithery",           "sex": 1,           "language": "zh_CN",           "city": "揭阳",           "province": "广东",           "country": "中国",           "headimgurl": "http://wx.qlogo.cn/mmopen/xbIQx1GRqdvyqkMMhEaGOX802l1CyqMJNgUzKP8MeAeHFicRDSnZH7FY4XB7p8XHXIf6uJA2SCunTPicGKezDC4saKISzRj3nz/0",          "subscribe_time": 1434093047,           "unionid": "oR5GjjgEhCMJFyzaVZdrxZ2zRRF4",           "remark": "",           "groupid": 0,          "tagid_list":[128,2]      },       {          "subscribe": 0,           "openid": "otvxTs_JZ6SEiP0imdhpi50fuSZg",           "unionid": "oR5GjjjrbqBZbrnPwwmSxFukE41U",       }  ]}

参数说明

参数 说明 subscribe 用户是否订阅该公众号标识,值为0时,代表此用户没有关注该公众号,拉取不到其余信息,只有openid和UnionID(在该公众号绑定到了微信开放平台账号时才有)。 openid 用户的标识,对当前公众号唯一 nickname 用户的昵称 sex 用户的性别,值为1时是男性,值为2时是女性,值为0时是未知 city 用户所在城市 country 用户所在国家 province 用户所在省份 language 用户的语言,简体中文为zh_CN headimgurl 用户头像,最后一个数值代表正方形头像大小(有0、46、64、96、132数值可选,0代表640*640正方形头像),用户没有头像时该项为空。若用户更换头像,原有头像URL将失效。 subscribe_time 用户关注时间,为时间戳。如果用户曾多次关注,则取最后关注时间 unionid 只有在用户将公众号绑定到微信开放平台帐号后,才会出现该字段。 remark 公众号运营者对粉丝的备注,公众号运营者可在微信公众平台用户管理界面对粉丝添加备注 groupid 用户所在的分组ID(暂时兼容用户分组旧接口) tagid_list 用户被打上的标签ID列表


错误时微信会返回错误码等信息,JSON数据包示例如下(该示例为AppID无效错误):

{"errcode":40013,"errmsg":"invalid appid"}

三、总结

跟微信公众平台的其他接口一样,获取用户基本信息无非就是发送http的GET请求,带上access_token和openid参数。主要是access_token和openid的获取。access_token有专门的接口去获取,注意不要超过有效时间,openid根据微信网页授权接口获取到。如果access_token和openid的任何一个参数错误,都会返回错误信息。