Package com.foxinmy.weixin4j.mp.api

Class UserApi

  • public class UserApi
extends MpApi
    用户相关API
    Since:
    JDK 1.6
    Author:
    jinyu(foxinmy@gmail.com)
    See Also:
    User

    • Constructor Detail

      • UserApi

        public UserApi​(com.foxinmy.weixin4j.token.TokenManager tokenManager)

    • Method Detail

      • getUser

        public User getUser​(String openId)
             throws com.foxinmy.weixin4j.exception.WeixinException
        获取用户信息
        Parameters:
        openId - 用户对应的ID
        Returns:
        用户对象
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException

      • getUser

        public User getUser​(String openId,
                    Lang lang)
             throws com.foxinmy.weixin4j.exception.WeixinException
        获取用户信息

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

        Parameters:
        openId - 用户对应的ID
        lang - 国家地区语言版本
        Returns:
        用户对象
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        获取用户信息, Lang, User

      • getUsers

        public List<User> getUsers​(String... openIds)
                    throws com.foxinmy.weixin4j.exception.WeixinException
        批量获取用户信息
        Parameters:
        openIds - 用户ID
        Returns:
        用户列表
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        获取用户信息, User

      • getUsers

        public List<User> getUsers​(Lang lang,
                           String... openIds)
                    throws com.foxinmy.weixin4j.exception.WeixinException
        批量获取用户信息
        Parameters:
        lang - 国家地区语言版本
        openIds - 用户ID 最多100个
        Returns:
        用户列表
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        获取用户信息, Lang, User

      • getFollowing

        public Following getFollowing​(String nextOpenId)
                       throws com.foxinmy.weixin4j.exception.WeixinException
        获取公众号一定数量(10000)的关注者列表 请慎重使用
        Parameters:
        nextOpenId - 下一次拉取数据的openid 不填写则默认从头开始拉取
        Returns:
        关注者信息 包含用户的详细信息
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        获取关注者列表, 批量获取用户信息, Following, User

      • getFollowingOpenIds

        public Following getFollowingOpenIds​(String nextOpenId)
                              throws com.foxinmy.weixin4j.exception.WeixinException
        获取公众号一定数量(10000)的关注者列表
        Parameters:
        nextOpenId - 下一次拉取数据的openid 不填写则默认从头开始拉取
        Returns:
        关注者信息 不包含用户的详细信息
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        获取关注者列表, Following

      • getAllFollowing

        public List<User> getAllFollowing()
                           throws com.foxinmy.weixin4j.exception.WeixinException
        获取公众号全部的关注者列表 请慎重使用

        当公众号关注者数量超过10000时,可通过填写next_openid的值,从而多次拉取列表的方式来满足需求, 将上一次调用得到的返回中的next_openid值,作为下一次调用中的next_openid值

        Returns:
        用户对象集合
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        获取关注者列表, 批量获取用户信息, User, Following, getFollowing(String)

      • getAllFollowingOpenIds

        public List<String> getAllFollowingOpenIds()
                                    throws com.foxinmy.weixin4j.exception.WeixinException
        获取公众号全部的关注者列表 请慎重使用

        当公众号关注者数量超过10000时,可通过填写next_openid的值,从而多次拉取列表的方式来满足需求, 将上一次调用得到的返回中的next_openid值,作为下一次调用中的next_openid值

        Returns:
        用户openid集合
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        获取关注者列表, getFollowingOpenIds(String)

      • remarkUserName

        public com.foxinmy.weixin4j.http.weixin.ApiResult remarkUserName​(String openId,
                                                                 String remark)
                                                          throws com.foxinmy.weixin4j.exception.WeixinException
        设置用户备注名
        Parameters:
        openId - 用户ID
        remark - 备注名
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        设置用户备注名

      • batchChangeOpenid

        public List<ChangeOpenidResult> batchChangeOpenid​(String fromAppid,
                                                  List<String> openIds)
                                           throws com.foxinmy.weixin4j.exception.WeixinException
        批量转换openid
        Parameters:
        fromAppid - 原账号ID
        openIds - 原账号openid列表，最多不能超过100个
        Returns:
        转换后的openid
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        openid转换, ChangeOpenidResult

      • changeAllOpenid

        public List<ChangeOpenidResult> changeAllOpenid​(String fromAppid)
                                         throws com.foxinmy.weixin4j.exception.WeixinException
        转换所有openid
        Parameters:
        fromAppid - 原账号ID
        Returns:
        转换后的openid
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        openid转换, ChangeOpenidResult