weixin.popular.api

类 UserAPI

java.lang.Object

weixin.popular.api.BaseAPI

weixin.popular.api.UserAPI

public class UserAPI
extends BaseAPI

User API

作者:

LiYi

构造器概要

构造器

构造器和说明
UserAPI()

方法概要

限定符和类型	方法和说明
static weixin.popular.bean.user.Group	groupsCreate(String access_token, String name) 创建分组
static BaseResult	groupsDelete(String access_token, String id) 删除分组
static weixin.popular.bean.user.Group	groupsGet(String access_token) 查询所有分组
static weixin.popular.bean.user.Group	groupsGetid(String access_token, String openid) 查询用户所在分组
static BaseResult	groupsMembersBatchUpdate(String access_token, List<String> openid_list, String to_groupid) 批量移动用户分组
static BaseResult	groupsMembersUpdate(String access_token, String openid, String to_groupid) 移动用户分组
static BaseResult	groupsUpdate(String access_token, String id, String name) 修改分组名
static weixin.popular.bean.user.TagsCreatResult	tagsCreate(String access_token, String name) 标签管理 创建标签 一个公众号，最多可以创建100个标签。
static BaseResult	tagsDelete(String access_token, Integer id) 标签管理 删除标签 请注意，当某个标签下的粉丝超过10w时，后台不可直接删除标签。
static weixin.popular.bean.user.TagsGetResult	tagsGet(String access_token) 标签管理 获取公众号已创建的标签
static weixin.popular.bean.user.TagsGetidlistResult	tagsGetidlist(String access_token, String openid) 用户管理 获取用户身上的标签列表
static BaseResult	tagsMembersBatchblacklist(String access_token, String[] openid_list) 黑名单管理 拉黑用户
static BaseResult	tagsMembersBatchtagging(String access_token, Integer tagid, String[] openids) 用户管理 批量为用户打标签 标签功能目前支持公众号为用户打上最多20个标签。
static BaseResult	tagsMembersBatchunblacklist(String access_token, String[] openid_list) 黑名单管理 取消拉黑用户
static BaseResult	tagsMembersBatchuntagging(String access_token, Integer tagid, String[] openids) 用户管理 批量为用户取消标签
static weixin.popular.bean.user.GetblacklistResult	tagsMembersGetblacklist(String access_token, String begin_openid) 黑名单管理 获取公众号的黑名单列表 该接口每次调用最多可拉取 10000 个OpenID，当列表数较多时，可以通过多次拉取的方式来满足需求。
static BaseResult	tagsUpdate(String access_token, Integer id, String name) 标签管理 编辑标签
static weixin.popular.bean.user.FollowResult	userGet(String access_token, String next_openid) 获取关注列表
static weixin.popular.bean.user.User	userInfo(String access_token, String openid) 获取用户基本信息
static weixin.popular.bean.user.User	userInfo(String access_token, String openid, int emoji) 获取用户基本信息
static weixin.popular.bean.user.UserInfoList	userInfoBatchget(String access_token, String lang, List<String> openids) 批量获取用户基本信息
static weixin.popular.bean.user.UserInfoList	userInfoBatchget(String access_token, String lang, List<String> openids, int emoji) 批量获取用户基本信息
static BaseResult	userInfoUpdateremark(String access_token, String openid, String remark) 设置备注名
static weixin.popular.bean.user.UserTagGetResult	userTagGet(String access_token, Integer tagid, String next_openid) 标签管理 获取标签下粉丝列表

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

UserAPI

public UserAPI()

方法详细资料

userInfo

public static weixin.popular.bean.user.User userInfo(String access_token,
                                                     String openid,
                                                     int emoji)

获取用户基本信息

参数:

access_token - access_token

openid - openid

emoji - 表情解析方式
0 不设置
1 HtmlHex 格式
2 HtmlTag 格式
3 Alias 格式
4 HtmlDec 格式
5 PureText 纯文本

返回:

User

从以下版本开始:

2.7.1

userInfo

public static weixin.popular.bean.user.User userInfo(String access_token,
                                                     String openid)

获取用户基本信息

参数:

access_token - access_token

openid - openid

返回:

User

userGet

public static weixin.popular.bean.user.FollowResult userGet(String access_token,
                                                            String next_openid)

获取关注列表

参数:

access_token - access_token

next_openid - 第一次获取使用null

返回:

FollowResult

userInfoBatchget

public static weixin.popular.bean.user.UserInfoList userInfoBatchget(String access_token,
                                                                     String lang,
                                                                     List<String> openids,
                                                                     int emoji)

批量获取用户基本信息

参数:

access_token - access_token

lang - zh-CN

openids - 最多支持一次拉取100条

emoji - 表情解析方式
0 不设置
1 HtmlHex 格式
2 HtmlTag 格式
3 Alias 格式
4 HtmlDec 格式
5 PureText 纯文本

返回:

UserInfoList

从以下版本开始:

2.7.1

userInfoBatchget

public static weixin.popular.bean.user.UserInfoList userInfoBatchget(String access_token,
                                                                     String lang,
                                                                     List<String> openids)

批量获取用户基本信息

参数:

access_token - access_token

lang - zh-CN

openids - 最多支持一次拉取100条

返回:

UserInfoList

userInfoUpdateremark

public static BaseResult userInfoUpdateremark(String access_token,
                                              String openid,
                                              String remark)

设置备注名

参数:

access_token - access_token

openid - openid

remark - remark

返回:

BaseResult

groupsCreate

public static weixin.popular.bean.user.Group groupsCreate(String access_token,
                                                          String name)

创建分组

参数:

access_token - access_token

name - name

返回:

Group

groupsGet

public static weixin.popular.bean.user.Group groupsGet(String access_token)

查询所有分组

参数:

access_token - access_token

返回:

Group

groupsGetid

public static weixin.popular.bean.user.Group groupsGetid(String access_token,
                                                         String openid)

查询用户所在分组

参数:

access_token - access_token

openid - openid

返回:

Group

groupsUpdate

public static BaseResult groupsUpdate(String access_token,
                                      String id,
                                      String name)

修改分组名

参数:

access_token - access_token

id - 分组ID

name - 分组名

返回:

BaseResult

groupsMembersUpdate

public static BaseResult groupsMembersUpdate(String access_token,
                                             String openid,
                                             String to_groupid)

移动用户分组

参数:

access_token - access_token

openid - openid

to_groupid - to_groupid

返回:

BaseResult

groupsMembersBatchUpdate

public static BaseResult groupsMembersBatchUpdate(String access_token,
                                                  List<String> openid_list,
                                                  String to_groupid)

批量移动用户分组

参数:

access_token - access_token

openid_list - openid_list

to_groupid - to_groupid

返回:

BaseResult

groupsDelete

public static BaseResult groupsDelete(String access_token,
                                      String id)

删除分组

参数:

access_token - access_token

id - id

返回:

BaseResult

tagsCreate

public static weixin.popular.bean.user.TagsCreatResult tagsCreate(String access_token,
                                                                  String name)

标签管理 创建标签
一个公众号，最多可以创建100个标签。

参数:

access_token - access_token

name - name 标签名长度超过30个字节

返回:

result

从以下版本开始:

2.8.1

tagsGet

public static weixin.popular.bean.user.TagsGetResult tagsGet(String access_token)

标签管理 获取公众号已创建的标签

参数:

access_token - access_token

返回:

result

从以下版本开始:

2.8.1

tagsUpdate

public static BaseResult tagsUpdate(String access_token,
                                    Integer id,
                                    String name)

标签管理 编辑标签

参数:

access_token - access_token

id - id

name - name 标签名长度超过30个字节

返回:

result

从以下版本开始:

2.8.1

tagsDelete

public static BaseResult tagsDelete(String access_token,
                                    Integer id)

标签管理 删除标签
请注意，当某个标签下的粉丝超过10w时，后台不可直接删除标签。
此时，开发者可以对该标签下的openid列表，先进行取消标签的操作，直到粉丝数不超过10w后，才可直接删除该标签。

参数:

access_token - access_token

id - id

返回:

result

从以下版本开始:

2.8.1

userTagGet

public static weixin.popular.bean.user.UserTagGetResult userTagGet(String access_token,
                                                                   Integer tagid,
                                                                   String next_openid)

标签管理 获取标签下粉丝列表

参数:

access_token - access_token

tagid - tagid

next_openid - 第一个拉取的OPENID，不填默认从头开始拉取

返回:

result

从以下版本开始:

2.8.1

tagsMembersBatchtagging

public static BaseResult tagsMembersBatchtagging(String access_token,
                                                 Integer tagid,
                                                 String[] openids)

用户管理 批量为用户打标签
标签功能目前支持公众号为用户打上最多20个标签。

参数:

access_token - access_token

tagid - tagid

openids - openids

返回:

result

从以下版本开始:

2.8.1

tagsMembersBatchuntagging

public static BaseResult tagsMembersBatchuntagging(String access_token,
                                                   Integer tagid,
                                                   String[] openids)

用户管理 批量为用户取消标签

参数:

access_token - access_token

tagid - tagid

openids - openids

返回:

result

从以下版本开始:

2.8.1

tagsGetidlist

public static weixin.popular.bean.user.TagsGetidlistResult tagsGetidlist(String access_token,
                                                                         String openid)

用户管理 获取用户身上的标签列表

参数:

access_token - access_token

openid - openid

返回:

result

从以下版本开始:

2.8.1

tagsMembersGetblacklist

public static weixin.popular.bean.user.GetblacklistResult tagsMembersGetblacklist(String access_token,
                                                                                  String begin_openid)

黑名单管理 获取公众号的黑名单列表
该接口每次调用最多可拉取 10000 个OpenID，当列表数较多时，可以通过多次拉取的方式来满足需求。

参数:

access_token - access_token

begin_openid - 当 begin_openid 为空时，默认从开头拉取。

返回:

result

从以下版本开始:

2.8.1

tagsMembersBatchblacklist

public static BaseResult tagsMembersBatchblacklist(String access_token,
                                                   String[] openid_list)

黑名单管理 拉黑用户

参数:

access_token - access_token

openid_list - 需要拉入黑名单的用户的openid，一次拉黑最多允许20个

返回:

result

从以下版本开始:

2.8.1

tagsMembersBatchunblacklist

public static BaseResult tagsMembersBatchunblacklist(String access_token,
                                                     String[] openid_list)

黑名单管理 取消拉黑用户

参数:

access_token - access_token

openid_list - 需要取消拉入黑名单的用户的openid，一次取消拉黑最多允许20个

返回:

result

从以下版本开始:

2.8.1