在上個(gè)月的對(duì)C#開發(fā)微信門戶及應(yīng)用做了介紹，寫過(guò)了幾篇的隨筆進(jìn)行分享，由于時(shí)間關(guān)系，間隔了一段時(shí)間沒(méi)有繼續(xù)寫這個(gè)系列的博客了，并不是對(duì)這個(gè)方面停止了研究，而是繼續(xù)深入探索這方面的技術(shù)，為了更好的應(yīng)用起來(lái)，專心做好底層的技術(shù)開發(fā)。本篇繼續(xù)上一篇的介紹，主要介紹分組管理方面的開發(fā)應(yīng)用，這篇的內(nèi)容和上一篇，作為一個(gè)完整的用戶信息和分組信息管理的組合。
1、用戶分組管理內(nèi)容
用戶分組的引入，主要是方便管理關(guān)注者列表，以及方便向不同的組別發(fā)送消息的操作的，一個(gè)公眾賬號(hào)，最多支持創(chuàng)建500個(gè)分組。
用戶分組管理，包含下面幾個(gè)方面的內(nèi)容：
1 創(chuàng)建分組
2 查詢所有分組
3 查詢用戶所在分組
4 修改分組名
5 移動(dòng)用戶分組
微信對(duì)于創(chuàng)建分組的定義如下所示。
http請(qǐng)求方式: POST（請(qǐng)使用https協(xié)議）
https://api.weixin.qq.com/cgi-bin/groups/create?access_token=ACCESS_TOKEN
POST數(shù)據(jù)格式：json
POST數(shù)據(jù)例子：{"group":{"name":"test"}}
正常返回的結(jié)果如下所示。
{
"group": {
"id": 107,
"name": "test"
}
}其他接口，也是類似的方式，通過(guò)POST一些參數(shù)進(jìn)去URL里面，獲取返回的Json數(shù)據(jù)。
前面隨筆定義了GroupJson的實(shí)體類信息如下所示。
/// <summary>
/// 分組信息
/// </summary>
public class GroupJson : BaseJsonResult
{
/// <summary>
/// 分組id，由微信分配
/// </summary>
public int id { get; set; }
/// <summary>
/// 分組名字，UTF8編碼
/// </summary>
public string name { get; set; }
}
根據(jù)以上幾個(gè)接口的定義，我定義了幾個(gè)接口，并把它們歸納到用戶管理的API接口里面。
/// <summary>
/// 查詢所有分組
/// </summary>
/// <param name="accessToken">調(diào)用接口憑證</param>
/// <returns></returns>
List<GroupJson> GetGroupList(string accessToken);
/// <summary>
/// 創(chuàng)建分組
/// </summary>
/// <param name="accessToken">調(diào)用接口憑證</param>
/// <param name="name">分組名稱</param>
/// <returns></returns>
GroupJson CreateGroup(string accessToken, string name);
/// <summary>
/// 查詢用戶所在分組
/// </summary>
/// <param name="accessToken">調(diào)用接口憑證</param>
/// <param name="openid">用戶的OpenID</param>
/// <returns></returns>
int GetUserGroupId(string accessToken, string openid);
/// <summary>
/// 修改分組名
/// </summary>
/// <param name="accessToken">調(diào)用接口憑證</param>
/// <param name="id">分組id，由微信分配</param>
/// <param name="name">分組名字（30個(gè)字符以內(nèi)）</param>
/// <returns></returns>
CommonResult UpdateGroupName(string accessToken, int id, string name);
/// <summary>
/// 移動(dòng)用戶分組
/// </summary>
/// <param name="accessToken">調(diào)用接口憑證</param>
/// <param name="openid">用戶的OpenID</param>
/// <param name="to_groupid">分組id</param>
/// <returns></returns>
CommonResult MoveUserToGroup(string accessToken, string openid, int to_groupid);
2、用戶分組管理接口的實(shí)現(xiàn)
2.1 創(chuàng)建用戶分組
為了解析如何實(shí)現(xiàn)創(chuàng)建用戶分組的POST數(shù)據(jù)操作，我們來(lái)一步步了解創(chuàng)建用戶的具體過(guò)程。
首先需要?jiǎng)?chuàng)建一個(gè)動(dòng)態(tài)定義的實(shí)體類信息，它包含幾個(gè)需要提及的屬性，如下所示。
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();
其中我們把對(duì)象轉(zhuǎn)換為合適的Json數(shù)據(jù)操作，放到了擴(kuò)展方法ToJson里面了，這個(gè)主要就是方便把動(dòng)態(tài)定義的實(shí)體類轉(zhuǎn)換Json內(nèi)容，主要就是調(diào)用Json.NET的序列號(hào)操作。
/// <summary>
/// 把對(duì)象為json字符串
/// </summary>
/// <param name="obj">待序列號(hào)對(duì)象</param>
/// <returns></returns>
public static string ToJson(this object obj)
{
return JsonConvert.SerializeObject(obj, Formatting.Indented);
}
準(zhǔn)備好Post的數(shù)據(jù)后，我們就進(jìn)一步看看獲取數(shù)據(jù)并轉(zhuǎn)換為合適格式的操作代碼。
GroupJson group = null;
CreateGroupResult result = JsonHelper<CreateGroupResult>.ConvertJson(url, postData);
if (result != null)
{
group = result.group;
}
其中POST數(shù)據(jù)并轉(zhuǎn)換為合適格式實(shí)體類的操作，放在了ConvertJson方法里面，這個(gè)方法的定義如下所示，里面的HttpHelper是我公用類庫(kù)的輔助類，主要就是調(diào)用底層的httpWebRequest對(duì)象方法，進(jìn)行數(shù)據(jù)的提交，并獲取返回結(jié)果。
/// <summary>
/// 轉(zhuǎn)換Json字符串到具體的對(duì)象
/// </summary>
/// <param name="url">返回Json數(shù)據(jù)的鏈接地址</param>
/// <param name="postData">POST提交的數(shù)據(jù)</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;
}
這樣，完整的創(chuàng)建用戶分組的操作函數(shù)如下所示。
/// <summary>
/// 創(chuàng)建分組
/// </summary>
/// <param name="accessToken">調(diào)用接口憑證</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 查詢所有分組
查詢所有分組，可以把服務(wù)器上的分組全部獲取下來(lái)，也就是每個(gè)分組的ID和名稱。
/// <summary>
/// 查詢所有分組
/// </summary>
/// <param name="accessToken">調(diào)用接口憑證</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 查詢用戶所在分組
每個(gè)用戶都屬于一個(gè)分組，默認(rèn)在 未分組 這個(gè)分組里面，我們可以通過(guò)API獲取用戶的分組信息，也就是獲取所在用戶分組的ID。
/// <summary>
/// 查詢用戶所在分組
/// </summary>
/// <param name="accessToken">調(diào)用接口憑證</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 修改分組名稱
也可以在實(shí)際中，調(diào)整用戶所在的分組，操作代碼如下。
/// <summary>
/// 修改分組名
/// </summary>
/// <param name="accessToken">調(diào)用接口憑證</param>
/// <param name="id">分組id，由微信分配</param>
/// <param name="name">分組名字（30個(gè)字符以內(nèi)）</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是，一個(gè)實(shí)體類，包含了bool的成功與否的標(biāo)志，以及String類型的錯(cuò)誤信息（如果有的話）。
對(duì)于這個(gè)GetExecuteResult函數(shù)體，里面主要就是提交數(shù)據(jù)，然后獲取結(jié)果，并根據(jù)結(jié)果進(jìn)行處理的函數(shù)。
/// <summary>
/// 通用的操作結(jié)果
/// </summary>
/// <param name="url">網(wǎng)頁(yè)地址</param>
/// <param name="postData">提交的數(shù)據(jù)內(nèi)容</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.請(qǐng)求成功);
success.ErrorMessage = result.errmsg;
}
}
catch (WeixinException ex)
{
success.ErrorMessage = ex.Message;
}
return success;
}
}
上面紅色部分的意思，就是轉(zhuǎn)換為實(shí)體類的時(shí)候，如果錯(cuò)誤是微信里面定義的，那么記錄錯(cuò)誤信息，其他異常我不處理（也就是拋出去）。
2.5 移動(dòng)用戶到新的分組
移動(dòng)用戶到新的分組的操作和上面小節(jié)的差不多，具體看代碼。
/// <summary>
/// 移動(dòng)用戶分組
/// </summary>
/// <param name="accessToken">調(diào)用接口憑證</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、用戶分組接口的調(diào)用
上面小節(jié)，定義并實(shí)現(xiàn)了用戶分組的各類接口，所有的用戶相關(guān)的都已經(jīng)毫無(wú)保留貼出代碼，它的調(diào)用操作如下代碼所示（測(cè)試代碼）。
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, "創(chuàng)建測(cè)試分組");
if (info != null)
{
string tips = string.Format("GroupId:{0} GroupName:{1}", info.id, info.name);
Console.WriteLine(tips);
string newName = "創(chuàng)建測(cè)試修改";
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 = "創(chuàng)建測(cè)試修改";
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("移動(dòng)用戶分組名稱：" + (result.Success ? "成功" : "失敗:" + result.ErrorMessage));
}
}
了解了上面的代碼和調(diào)用規(guī)則，我們就能通過(guò)API進(jìn)行用戶分組信息的管理了。通過(guò)在應(yīng)用程序中集成相關(guān)的接口代碼，我們就能夠很好的控制我們的關(guān)注用戶列表和用戶分組信息。從而為我們下一步用戶的信息推送打好基礎(chǔ)。
C#開發(fā)微信門戶及應(yīng)用(20)-微信企業(yè)號(hào)的菜單管理
C#開發(fā)微信門戶及應(yīng)用(19)-微信企業(yè)號(hào)的消息發(fā)送（文本、圖片、文件、語(yǔ)音、視頻、圖文消息等）
C#開發(fā)微信門戶及應(yīng)用(18)-微信企業(yè)號(hào)的通訊錄管理開發(fā)之成員管理
C#開發(fā)微信門戶及應(yīng)用(17)-微信企業(yè)號(hào)的通訊錄管理開發(fā)之部門管理
C#開發(fā)微信門戶及應(yīng)用(16)-微信企業(yè)號(hào)的配置和使用
C#開發(fā)微信門戶及應(yīng)用(15)-微信菜單增加掃一掃、發(fā)圖片、發(fā)地理位置功能
C#開發(fā)微信門戶及應(yīng)用(14)-在微信菜單中采用重定向獲取用戶數(shù)據(jù)
C#開發(fā)微信門戶及應(yīng)用(13)-使用地理位置擴(kuò)展相關(guān)應(yīng)用
C#開發(fā)微信門戶及應(yīng)用(12)-使用語(yǔ)音處理
C#開發(fā)微信門戶及應(yīng)用(11)--微信菜單的多種表現(xiàn)方式介紹
C#開發(fā)微信門戶及應(yīng)用(10)--在管理系統(tǒng)中同步微信用戶分組信息
C#開發(fā)微信門戶及應(yīng)用(9)-微信門戶菜單管理及提交到微信服務(wù)器
C#開發(fā)微信門戶及應(yīng)用(8)-微信門戶應(yīng)用管理系統(tǒng)功能介紹
C#開發(fā)微信門戶及應(yīng)用(7)-微信多客服功能及開發(fā)集成
C#開發(fā)微信門戶及應(yīng)用(6)--微信門戶菜單的管理操作
C#開發(fā)微信門戶及應(yīng)用(5)--用戶分組信息管理
C#開發(fā)微信門戶及應(yīng)用(4)--關(guān)注用戶列表及詳細(xì)信息管理
C#開發(fā)微信門戶及應(yīng)用(3)--文本消息和圖文消息的應(yīng)答
C#開發(fā)微信門戶及應(yīng)用(2)--微信消息的處理和應(yīng)答
C#開發(fā)微信門戶及應(yīng)用(1)--開始使用微信接口
主要研究技術(shù)：代碼生成工具、Visio二次開發(fā)、客戶關(guān)系管理軟件、送水管理軟件等共享軟件開發(fā)
400 186 1886
