C#开发微信门户及应用(18)-微信企业号的通讯录管理开发之成员管理
在上篇隨筆《C#開發(fā)微信門戶及應(yīng)用(17)-微信企業(yè)號的通訊錄管理開發(fā)之部門管理》介紹了通訊錄的部門的相關(guān)操作管理，通訊錄管理包括部門管理、成員管理、標(biāo)簽管理三個部分，本篇主要介紹成員的管理操作，包括創(chuàng)建、刪除、更新、獲取、獲取部門成員幾個操作要點。
1、成員的創(chuàng)建操作
為了方便，我們可以創(chuàng)建一個部門組織結(jié)構(gòu)，這是開發(fā)的前提，因為我們通訊錄管理，也是基于一個組織機(jī)構(gòu)下的，如上篇介紹的組織結(jié)構(gòu)層次一樣。我這里創(chuàng)建一個廣州愛奇迪的根結(jié)構(gòu)，然后在其中在創(chuàng)建一些組織機(jī)構(gòu)，如下圖所示。
在后臺可以通過功能操作添加人員，本篇主要介紹如何調(diào)用微信企業(yè)號API進(jìn)行人員管理的操作。
創(chuàng)建人員的API定義如下所示。
- 請求說明
Https請求方式: POST
https://qyapi.weixin.qq.com/cgi-bin/user/create?access_token=ACCESS_TOKEN
請求包結(jié)構(gòu)體為:
{"userid": "zhangsan","name": "張三","department": [1, 2],"position": "產(chǎn)品經(jīng)理","mobile": "15913215421","gender": 1,"tel": "62394","email": "zhangsan@gzdev.com","weixinid": "zhangsan4dev" }- 參數(shù)說明
| access_token | 是 | 調(diào)用接口憑證 |
| userid | 是 | 員工UserID。對應(yīng)管理端的帳號，企業(yè)內(nèi)必須唯一。長度為1~64個字符 |
| name | 是 | 成員名稱。長度為1~64個字符 |
| department | 否 | 成員所屬部門id列表。注意，每個部門的直屬員工上限為1000個 |
| position | 否 | 職位信息。長度為0~64個字符 |
| mobile | 否 | 手機(jī)號碼。企業(yè)內(nèi)必須唯一，mobile/weixinid/email三者不能同時為空 |
| gender | 否 | 性別。gender=0表示男，=1表示女。默認(rèn)gender=0 |
| tel | 否 | 辦公電話。長度為0~64個字符 |
| 否 | 郵箱。長度為0~64個字符。企業(yè)內(nèi)必須唯一 | |
| weixinid | 否 | 微信號。企業(yè)內(nèi)必須唯一 |
- 權(quán)限說明
管理員須擁有“操作通訊錄”的接口權(quán)限，以及指定部門的管理權(quán)限。
- 返回結(jié)果
?我們在C#里面，需要定義對應(yīng)給的接口，然后根據(jù)需要構(gòu)造對應(yīng)的傳遞實體信息。
這里我把人員管理的接口全部定義好，接口定義如下所示。
#region 部門成員管理/// <summary>/// 創(chuàng)建成員/// </summary>CommonResult CreateUser(string accessToken, CorpUserJson user);/// <summary>/// 更新成員/// </summary>CommonResult UpdateUser(string accessToken, CorpUserUpdateJson user);/// <summary>/// 刪除成員/// </summary>CommonResult DeleteUser(string accessToken, string userid);/// <summary>/// 根據(jù)成員id獲取成員信息/// </summary>CorpUserGetJson GetUser(string accessToken, string userid);/// <summary>/// 獲取部門成員/// </summary>CorpUserListJson GetDeptUser(string accessToken, int department_id, int fetch_child = 0, int status = 0);#endregion然后根據(jù)信息定義，創(chuàng)建一個承載人員信息的CorpUserJson實體對象，創(chuàng)建人員的實現(xiàn)操作代碼如下所示。
/// <summary>/// 創(chuàng)建成員/// </summary>public CommonResult CreateUser(string accessToken, CorpUserJson user){string urlFormat = "https://qyapi.weixin.qq.com/cgi-bin/user/create?access_token={0}";var data = new{userid = user.userid,name = user.name,department = user.department,position = user.position,mobile = user.mobile,gender = user.gender,tel = user.tel,email = user.email,weixinid = user.weixinid};var url = string.Format(urlFormat, accessToken);var postData = data.ToJson();return Helper.GetCorpExecuteResult(url, postData);}?
2、成員的更新操作
成員的數(shù)據(jù)更新和創(chuàng)建操作類似，它的企業(yè)號定義如下所示。
- 請求說明
Https請求方式: POST
https://qyapi.weixin.qq.com/cgi-bin/user/update?access_token=ACCESS_TOKEN
請求包示例如下（如果非必須的字段未指定，則不更新該字段之前的設(shè)置值）:
{"userid": "zhangsan","name": "李四","department": [1],"position": "后臺工程師","mobile": "15913215421","gender": 1,"tel": "62394","email": "zhangsan@gzdev.com","weixinid": "lisifordev","enable": 1 }由于它的操作數(shù)據(jù)類似，因此它的實現(xiàn)代碼也差不多，如下所示就是。
/// <summary>/// 更新成員/// </summary>public CommonResult UpdateUser(string accessToken, CorpUserUpdateJson user){string urlFormat = "https://qyapi.weixin.qq.com/cgi-bin/user/update?access_token={0}";//string postData = user.ToJson();var data = new{userid = user.userid,name = user.name,department = user.department,position = user.position,mobile = user.mobile,gender = user.gender,tel = user.tel,email = user.email,weixinid = user.weixinid,enable = user.enable};var url = string.Format(urlFormat, accessToken);var postData = data.ToJson();return Helper.GetCorpExecuteResult(url, postData);}?
3、成員的刪除、成員的獲取、部門成員的獲取操作
這些操作和上面的類似，不在贅述，主要就是根據(jù)需要定義他們對應(yīng)的返回數(shù)據(jù)信息，然后解析Json數(shù)據(jù)即可轉(zhuǎn)換為對應(yīng)的實體。
1）刪除人員的定義如下：
- 請求說明
Https請求方式: GET
https://qyapi.weixin.qq.com/cgi-bin/user/delete?access_token=ACCESS_TOKEN&userid=lisi
- 參數(shù)說明
| access_token | 是 | 調(diào)用接口憑證 |
| userid | 是 | 員工UserID。對應(yīng)管理端的帳號 |
- 返回結(jié)果
2）成員的獲取定義如下：
- 請求說明
Https請求方式: GET
https://qyapi.weixin.qq.com/cgi-bin/user/get?access_token=ACCESS_TOKEN&userid=lisi
- 參數(shù)說明
| access_token | 是 | 調(diào)用接口憑證 |
| userid | 是 | 員工UserID |
- 返回結(jié)果
3）部門成員的獲取定義如下：
- 請求說明
Https請求方式: GET
https://qyapi.weixin.qq.com/cgi-bin/user/simplelist?access_token=ACCESS_TOKEN&department_id=1&fetch_child=0&status=0
- 參數(shù)說明
| access_token | 是 | 調(diào)用接口憑證 |
| department_id | 是 | 獲取的部門id |
| fetch_child | 否 | 1/0：是否遞歸獲取子部門下面的成員 |
| status | 否 | 0獲取全部員工，1獲取已關(guān)注成員列表，2獲取禁用成員列表，4獲取未關(guān)注成員列表。status可疊加 |
- 權(quán)限說明
管理員須擁有’獲取部門成員’的接口權(quán)限，以及指定部門的查看權(quán)限。
- 返回結(jié)果
這個返回值我們定義一個實體對象用來存儲數(shù)據(jù)即可。
/// <summary>/// 獲取部門成員返回的數(shù)據(jù)/// </summary>public class CorpUserListJson : BaseJsonResult{public CorpUserListJson(){this.userlist = new List<CorpUserSimpleJson>();}/// <summary>/// 返回的錯誤消息/// </summary>public CorpReturnCode errcode { get; set; }/// <summary>/// 對返回碼的文本描述內(nèi)容/// </summary>public string errmsg { get; set; }/// <summary>/// 成員列表/// </summary>public List<CorpUserSimpleJson> userlist { get; set; }}?
7、綜合例子調(diào)用代碼
上面介紹了一些企業(yè)號的接口定義和我對API的C#封裝接口和部分實現(xiàn)代碼，實現(xiàn)了功能后，我們就可以在代碼中對它進(jìn)行測試，確信是否正常使用。
/// <summary>/// 人員管理綜合性操作（創(chuàng)建、修改、獲取信息、刪除）/// </summary>/// <param name="sender"></param>/// <param name="e"></param>private void btnCorpUser_Click(object sender, EventArgs e){CorpUserJson user = new CorpUserJson();user.userid = "test";user.name ="測試用戶";user.department = new List<int>(){2};user.email = "test@163.com";ICorpAddressBookApi bll = new CorpAddressBookApi();CommonResult result = bll.CreateUser(token, user);if (result != null){Console.WriteLine("創(chuàng)建成員:{0} {1} {2}", user.name, (result.Success ? "成功" : "失敗"), result.ErrorMessage);string name = "修改測試";user.name = name;CorpUserUpdateJson userUpdate = new CorpUserUpdateJson(user);result = bll.UpdateUser(token, userUpdate);if (result != null){Console.WriteLine("修改名稱:{0} {1} {2}", name, (result.Success ? "成功" : "失敗"), result.ErrorMessage);}CorpUserGetJson userGet = bll.GetUser(token, user.userid);if (userGet != null){Console.WriteLine("成員名稱:{0} ({1} {2})", userGet.name, user.userid, user.email);}result = bll.DeleteUser(token, user.userid);if (result != null){Console.WriteLine("刪除成員:{0} {1} {2}", name, (result.Success ? "成功" : "失敗"), result.ErrorMessage);}}}獲取部門人員的操作代碼如下所示。
/// <summary>/// 獲取部門人員/// </summary>private void btnCorpUserList_Click(object sender, EventArgs e){int deptId = 1;ICorpAddressBookApi bll = new CorpAddressBookApi();CorpUserListJson result = bll.GetDeptUser(token, deptId);if (result != null){foreach(CorpUserSimpleJson item in result.userlist){Console.WriteLine("成員名稱:{0} {1}", item.name, item.userid);}}}?
人員的管理，相對來說比較簡單，主要是在一定的部門下創(chuàng)建人員，然后也可以給標(biāo)簽增加相應(yīng)的人員，基本上就是這些了，不過一定需要確保有相應(yīng)的權(quán)限進(jìn)行操作。
如果對這個《C#開發(fā)微信門戶及應(yīng)用》系列感興趣，可以關(guān)注我的其他文章，系列隨筆如下所示：
C#開發(fā)微信門戶及應(yīng)用(25)-微信企業(yè)號的客戶端管理功能
C#開發(fā)微信門戶及應(yīng)用(24)-微信小店貨架信息管理
C#開發(fā)微信門戶及應(yīng)用(23)-微信小店商品管理接口的封裝和測試
C#開發(fā)微信門戶及應(yīng)用(22)-微信小店的開發(fā)和使用
C#開發(fā)微信門戶及應(yīng)用(21)-微信企業(yè)號的消息和事件的接收處理及解密?
C#開發(fā)微信門戶及應(yīng)用(20)-微信企業(yè)號的菜單管理
C#開發(fā)微信門戶及應(yīng)用(19)-微信企業(yè)號的消息發(fā)送（文本、圖片、文件、語音、視頻、圖文消息等）
C#開發(fā)微信門戶及應(yīng)用(18)-微信企業(yè)號的通訊錄管理開發(fā)之成員管理
C#開發(fā)微信門戶及應(yīng)用(17)-微信企業(yè)號的通訊錄管理開發(fā)之部門管理
C#開發(fā)微信門戶及應(yīng)用(16)-微信企業(yè)號的配置和使用
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)-使用語音處理
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)--開始使用微信接口
?
總結(jié)
以上是生活随笔為你收集整理的C#开发微信门户及应用(18)-微信企业号的通讯录管理开发之成员管理的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： Java程序员的推荐阅读书籍
- 下一篇： 《C#本质论》读书笔记（十二）构造器 @