C#开发微信门户及应用(5) 用户分组信息管理
在上个月的对c#开发微信门户及应用做了介绍,写过了几篇的随笔进行分享,由于时间关系,间隔了一段时间没有继续写这个系列的博客了,并不是对这个方面停止了研究,而是继续深入探索这方面的技术,为了更好的应用起来,专心做好底层的技术开发。本篇继续上一篇的介绍,主要介绍分组管理方面的开发应用,这篇的内容和上一篇,作为一个完整的用户信息和分组信息管理的组合。
1、用户分组管理内容
用户分组的引入,主要是方便管理关注者列表,以及方便向不同的组别发送消息的操作的,一个公众账号,最多支持创建500个分组。
用户分组管理,包含下面几个方面的内容:
1 创建分组
2 查询所有分组
3 查询用户所在分组
4 修改分组名
5 移动用户分组
微信对于创建分组的定义如下所示。
http请求方式: post(请使用https协议)
https://api.weixin.qq.com/cgi-bin/groups/create?access_token=access_token
post数据格式:json
post数据例子:{"group":{"name":"test"}}
正常返回的结果如下所示。
{ "group": { "id": 107, "name": "test" } }
其他接口,也是类似的方式,通过post一些参数进去url里面,获取返回的json数据。
前面随笔定义了groupjson的实体类信息如下所示。
/// <summary> /// 分组信息 /// </summary> public class groupjson : basejsonresult { /// <summary> /// 分组id,由微信分配 /// </summary> public int id { get; set; } /// <summary> /// 分组名字,utf8编码 /// </summary> public string name { get; set; } }
根据以上几个接口的定义,我定义了几个接口,并把它们归纳到用户管理的api接口里面。
/// <summary> /// 查询所有分组 /// </summary> /// <param name="accesstoken">调用接口凭证</param> /// <returns></returns> list<groupjson> getgrouplist(string accesstoken); /// <summary> /// 创建分组 /// </summary> /// <param name="accesstoken">调用接口凭证</param> /// <param name="name">分组名称</param> /// <returns></returns> groupjson creategroup(string accesstoken, string name); /// <summary> /// 查询用户所在分组 /// </summary> /// <param name="accesstoken">调用接口凭证</param> /// <param name="openid">用户的openid</param> /// <returns></returns> int getusergroupid(string accesstoken, string openid); /// <summary> /// 修改分组名 /// </summary> /// <param name="accesstoken">调用接口凭证</param> /// <param name="id">分组id,由微信分配</param> /// <param name="name">分组名字(30个字符以内)</param> /// <returns></returns> commonresult updategroupname(string accesstoken, int id, string name); /// <summary> /// 移动用户分组 /// </summary> /// <param name="accesstoken">调用接口凭证</param> /// <param name="openid">用户的openid</param> /// <param name="to_groupid">分组id</param> /// <returns></returns> commonresult moveusertogroup(string accesstoken, string openid, int to_groupid);
2、用户分组管理接口的实现
2.1 创建用户分组
为了解析如何实现创建用户分组的post数据操作,我们来一步步了解创建用户的具体过程。
首先需要创建一个动态定义的实体类信息,它包含几个需要提及的属性,如下所示。
string url = string.format("https://api.weixin.qq.com/cgi-bin/groups/create?access_token={0}", accesstoken); var data = new { group = new { name = name } }; string postdata = data.tojson();
其中我们把对象转换为合适的json数据操作,放到了扩展方法tojson里面了,这个主要就是方便把动态定义的实体类转换json内容,主要就是调用json.net的序列号操作。
/// <summary> /// 把对象为json字符串 /// </summary> /// <param name="obj">待序列号对象</param> /// <returns></returns> public static string tojson(this object obj) { return jsonconvert.serializeobject(obj, formatting.indented); }
准备好post的数据后,我们就进一步看看获取数据并转换为合适格式的操作代码。
groupjson group = null; creategroupresult result = jsonhelper<creategroupresult>.convertjson(url, postdata); if (result != null) { group = result.group; }
其中post数据并转换为合适格式实体类的操作,放在了convertjson方法里面,这个方法的定义如下所示,里面的httphelper是我公用类库的辅助类,主要就是调用底层的httpwebrequest对象方法,进行数据的提交,并获取返回结果。
/// <summary> /// 转换json字符串到具体的对象 /// </summary> /// <param name="url">返回json数据的链接地址</param> /// <param name="postdata">post提交的数据</param> /// <returns></returns> public static t convertjson(string url, string postdata) { httphelper helper = new httphelper(); string content = helper.gethtml(url, postdata, true); verifyerrorcode(content); t result = jsonconvert.deserializeobject<t>(content); return result; }
这样,完整的创建用户分组的操作函数如下所示。
/// <summary> /// 创建分组 /// </summary> /// <param name="accesstoken">调用接口凭证</param> /// <param name="name">分组名称</param> /// <returns></returns> public groupjson creategroup(string accesstoken, string name) { string url = string.format("https://api.weixin.qq.com/cgi-bin/groups/create?access_token={0}", accesstoken); var data = new { group = new { name = name } }; string postdata = data.tojson(); groupjson group = null; creategroupresult result = jsonhelper<creategroupresult>.convertjson(url, postdata); if (result != null) { group = result.group; } return group; }
2.2 查询所有分组
查询所有分组,可以把服务器上的分组全部获取下来,也就是每个分组的id和名称。
/// <summary> /// 查询所有分组 /// </summary> /// <param name="accesstoken">调用接口凭证</param> /// <returns></returns> public list<groupjson> getgrouplist(string accesstoken) { string url = string.format("https://api.weixin.qq.com/cgi-bin/groups/get?access_token={0}", accesstoken); list<groupjson> list = new list<groupjson>(); grouplistjsonresult result = jsonhelper<grouplistjsonresult>.convertjson(url); if (result != null && result.groups != null) { list.addrange(result.groups); } return list; }
2.3 查询用户所在分组
每个用户都属于一个分组,默认在 未分组 这个分组里面,我们可以通过api获取用户的分组信息,也就是获取所在用户分组的id。
/// <summary> /// 查询用户所在分组 /// </summary> /// <param name="accesstoken">调用接口凭证</param> /// <param name="openid">用户的openid</param> /// <returns></returns> public int getusergroupid(string accesstoken, string openid) { string url = string.format("https://api.weixin.qq.com/cgi-bin/groups/getid?access_token={0}", accesstoken); var data = new { openid = openid }; string postdata = data.tojson(); int groupid = -1; groupidjsonresult result = jsonhelper<groupidjsonresult>.convertjson(url, postdata); if (result != null) { groupid = result.groupid; } return groupid; }
2.4 修改分组名称
也可以在实际中,调整用户所在的分组,操作代码如下。
/// <summary> /// 修改分组名 /// </summary> /// <param name="accesstoken">调用接口凭证</param> /// <param name="id">分组id,由微信分配</param> /// <param name="name">分组名字(30个字符以内)</param> /// <returns></returns> public commonresult updategroupname(string accesstoken, int id, string name) { string url = string.format("https://api.weixin.qq.com/cgi-bin/groups/update?access_token={0}", accesstoken); var data = new { group = new { id = id, name = name } }; string postdata = data.tojson(); return helper.getexecuteresult(url, postdata); }
这里的返回值commonresult是,一个实体类,包含了bool的成功与否的标志,以及string类型的错误信息(如果有的话)。
对于这个getexecuteresult函数体,里面主要就是提交数据,然后获取结果,并根据结果进行处理的函数。
/// <summary> /// 通用的操作结果 /// </summary> /// <param name="url">网页地址</param> /// <param name="postdata">提交的数据内容</param> /// <returns></returns> public static commonresult getexecuteresult(string url, string postdata = null) { commonresult success = new commonresult(); try { errorjsonresult result; if (postdata != null) { result = jsonhelper<errorjsonresult>.convertjson(url, postdata); } else { result = jsonhelper<errorjsonresult>.convertjson(url); } if (result != null) { success.success = (result.errcode == returncode.请求成功); success.errormessage = result.errmsg; } } catch (weixinexception ex) { success.errormessage = ex.message; } return success; } }
上面红色部分的意思,就是转换为实体类的时候,如果错误是微信里面定义的,那么记录错误信息,其他异常我不处理(也就是抛出去)。
2.5 移动用户到新的分组
移动用户到新的分组的操作和上面小节的差不多,具体看代码。
/// <summary> /// 移动用户分组 /// </summary> /// <param name="accesstoken">调用接口凭证</param> /// <param name="openid">用户的openid</param> /// <param name="to_groupid">分组id</param> /// <returns></returns> public commonresult moveusertogroup(string accesstoken, string openid, int to_groupid) { string url = string.format("https://api.weixin.qq.com/cgi-bin/groups/members/update?access_token={0}", accesstoken); var data = new { openid = openid, to_groupid = to_groupid }; string postdata = data.tojson(); return helper.getexecuteresult(url, postdata); }
3、用户分组接口的调用
上面小节,定义并实现了用户分组的各类接口,所有的用户相关的都已经毫无保留贴出代码,它的调用操作如下代码所示(测试代码)。
private void btngetgrouplist_click(object sender, eventargs e) { iuserapi userbll = new userapi(); list<groupjson> list = userbll.getgrouplist(token); foreach (groupjson info in list) { string tips = string.format("{0}:{1}", info.name, info.id); console.writeline(tips); } } private void btnfindusergroup_click(object sender, eventargs e) { iuserapi userbll = new userapi(); int groupid = userbll.getusergroupid(token, openid); string tips = string.format("groupid:{0}", groupid); console.writeline(tips); } private void btncreategroup_click(object sender, eventargs e) { iuserapi userbll = new userapi(); groupjson info = userbll.creategroup(token, "创建测试分组"); if (info != null) { string tips = string.format("groupid:{0} groupname:{1}", info.id, info.name); console.writeline(tips); string newname = "创建测试修改"; commonresult result = userbll.updategroupname(token, info.id, newname); console.writeline("修改分组名称:" + (result.success ? "成功" : "失败:" + result.errormessage)); } } private void btnupdategroup_click(object sender, eventargs e) { int groupid = 111; string newname = "创建测试修改"; iuserapi userbll = new userapi(); commonresult result = userbll.updategroupname(token, groupid, newname); console.writeline("修改分组名称:" + (result.success ? "成功" : "失败:" + result.errormessage)); } private void btnmovetogroup_click(object sender, eventargs e) { int togroup_id = 111;//输入分组id if (togroup_id > 0) { iuserapi userbll = new userapi(); commonresult result = userbll.moveusertogroup(token, openid, togroup_id); console.writeline("移动用户分组名称:" + (result.success ? "成功" : "失败:" + result.errormessage)); } }
了解了上面的代码和调用规则,我们就能通过api进行用户分组信息的管理了。通过在应用程序中集成相关的接口代码,我们就能够很好的控制我们的关注用户列表和用户分组信息。从而为我们下一步用户的信息推送打好基础。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。