微信企業號的通訊錄管理開發之成員管理
作者：伍華聰
本篇主要介紹成員的管理操作，包括創建、刪除、更新、獲取、獲取部門成員幾個操作要點。
在上篇隨筆《微信企業號的通訊錄管理開發之部門管理》介紹了通訊錄的部門的相關操作管理，通訊錄管理包括部門管理、成員管理、標簽管理三個部分，本篇主要介紹成員的管理操作，包括創建、刪除、更新、獲取、獲取部門成員幾個操作要點。
1、成員的創建操作
為了方便，我們可以創建一個部門組織結構，這是開發的前提，因為我們通訊錄管理，也是基于一個組織機構下的，如上篇介紹的組織結構層次一樣。我這里創建一個廣州愛奇迪的根結構，然后在其中在創建一些組織機構，如下圖所示。
在后臺可以通過功能操作添加人員，本篇主要介紹如何調用微信企業號API進行人員管理的操作。
創建人員的API定義如下所示。
- 請求說明
Https請求方式: POST
https://qyapi.weixin.qq.com/cgi-bin/user/create?access_token=ACCESS_TOKEN
請求包結構體為:
- {
- "userid": "zhangsan",
- "name": "張三",
- "department": [1, 2],
- "position": "產品經理",
- "mobile": "15913215421",
- "gender": 1,
- "tel": "62394",
- "email": "zhangsan@gzdev.com",
- "weixinid": "zhangsan4dev"
- }
- 參數說明
| 參數 | 必須 | 說明 |
|---|---|---|
| access_token | 是 | 調用接口憑證 |
| userid | 是 | 員工UserID。對應管理端的帳號，企業內必須***。長度為1~64個字符 |
| name | 是 | 成員名稱。長度為1~64個字符 |
| department | 否 | 成員所屬部門id列表。注意，每個部門的直屬員工上限為1000個 |
| position | 否 | 職位信息。長度為0~64個字符 |
| mobile | 否 | 手機號碼。企業內必須***，mobile/weixinid/email三者不能同時為空 |
| gender | 否 | 性別。gender=0表示男，=1表示女。默認gender=0 |
| tel | 否 | 辦公電話。長度為0~64個字符 |
| 否 | 郵箱。長度為0~64個字符。企業內必須*** | |
| weixinid | 否 | 微信號。企業內必須*** |
- 權限說明
管理員須擁有“操作通訊錄”的接口權限，以及指定部門的管理權限。
- 返回結果
- {
- "errcode": 0,
- "errmsg": "created"
- }
我們在C#里面，需要定義對應給的接口，然后根據需要構造對應的傳遞實體信息。
這里我把人員管理的接口全部定義好，接口定義如下所示。
- #region 部門成員管理
- /// <summary>
- /// 創建成員
- /// </summary>
- CommonResult CreateUser(string accessToken, CorpUserJson user);
- /// <summary>
- /// 更新成員
- /// </summary>
- CommonResult UpdateUser(string accessToken, CorpUserUpdateJson user);
- /// <summary>
- /// 刪除成員
- /// </summary>
- CommonResult DeleteUser(string accessToken, string userid);
- /// <summary>
- /// 根據成員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
然后根據信息定義，創建一個承載人員信息的CorpUserJson實體對象，創建人員的實現操作代碼如下所示。
- /// <summary>
- /// 創建成員
- /// </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、成員的更新操作
成員的數據更新和創建操作類似，它的企業號定義如下所示。
- 請求說明
Https請求方式: POST
https://qyapi.weixin.qq.com/cgi-bin/user/update?access_token=ACCESS_TOKEN
請求包示例如下（如果非必須的字段未指定，則不更新該字段之前的設置值）:
- {
- "userid": "zhangsan",
- "name": "李四",
- "department": [1],
- "position": "后臺工程師",
- "mobile": "15913215421",
- "gender": 1,
- "tel": "62394",
- "email": "zhangsan@gzdev.com",
- "weixinid": "lisifordev",
- "enable": 1
- }
由于它的操作數據類似，因此它的實現代碼也差不多，如下所示就是。
- /// <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、成員的刪除、成員的獲取、部門成員的獲取操作
這些操作和上面的類似，不在贅述，主要就是根據需要定義他們對應的返回數據信息，然后解析Json數據即可轉換為對應的實體。
1）刪除人員的定義如下：
- 請求說明
Https請求方式: GET
https://qyapi.weixin.qq.com/cgi-bin/user/delete?access_token=ACCESS_TOKEN&userid=lisi
- 參數說明
| 參數 | 必須 | 說明 |
|---|---|---|
| access_token | 是 | 調用接口憑證 |
| userid | 是 | 員工UserID。對應管理端的帳號 |
- 返回結果
{
"errcode": 0,
"errmsg": "deleted"
}
2）成員的獲取定義如下：
- 請求說明
Https請求方式: GET
https://qyapi.weixin.qq.com/cgi-bin/user/get?access_token=ACCESS_TOKEN&userid=lisi
- 參數說明
| 參數 | 必須 | 說明 |
|---|---|---|
| access_token | 是 | 調用接口憑證 |
| userid | 是 | 員工UserID |
- 返回結果
{
"errcode": 0,
"errmsg": "ok",
"userid": "zhangsan",
"name": "李四",
"department": [1, 2],
"position": "后臺工程師",
"mobile": "15913215421",
"gender": 1,
"tel": "62394",
"email": "zhangsan@gzdev.com",
"weixinid": "lisifordev",
"avatar": "http://wx.qlogo.cn/mmopen/ajNVdqHZLLA3WJ6DSZUfiakYe37PKnQhBIeOQBO4czqrnZDS79FH5Wm5m4X69TBicnHFlhiafvDwklOpZeXYQQ2icg/0",
"status": 1
}
3）部門成員的獲取定義如下：
- 請求說明
Https請求方式: GET
- 參數說明
| 參數 | 必須 | 說明 |
|---|---|---|
| access_token | 是 | 調用接口憑證 |
| department_id | 是 | 獲取的部門id |
| fetch_child | 否 | 1/0：是否遞歸獲取子部門下面的成員 |
| status | 否 | 0獲取全部員工，1獲取已關注成員列表，2獲取禁用成員列表，4獲取未關注成員列表。status可疊加 |
- 權限說明
管理員須擁有’獲取部門成員’的接口權限，以及指定部門的查看權限。
- 返回結果
- {
- "errcode": 0,
- "errmsg": "ok",
- "userlist": [
- {
- "userid": "zhangsan",
- "name": "李四"
- }
- ]
- }
這個返回值我們定義一個實體對象用來存儲數據即可。
- /// <summary>
- /// 獲取部門成員返回的數據
- /// </summary>
- public class CorpUserListJson : BaseJsonResult
- {
- public CorpUserListJson()
- {
- this.userlist = new List<CorpUserSimpleJson>();
- }
- /// <summary>
- /// 返回的錯誤消息
- /// </summary>
- public CorpReturnCode errcode { get; set; }
- /// <summary>
- /// 對返回碼的文本描述內容
- /// </summary>
- public string errmsg { get; set; }
- /// <summary>
- /// 成員列表
- /// </summary>
- public List<CorpUserSimpleJson> userlist { get; set; }
- }
7、綜合例子調用代碼
上面介紹了一些企業號的接口定義和我對API的C#封裝接口和部分實現代碼，實現了功能后，我們就可以在代碼中對它進行測試，確信是否正常使用。
- /// <summary>
- /// 人員管理綜合性操作（創建、修改、獲取信息、刪除）
- /// </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("創建成員:{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);
- }
- }
- }
人員的管理，相對來說比較簡單，主要是在一定的部門下創建人員，然后也可以給標簽增加相應的人員，基本上就是這些了，不過一定需要確保有相應的權限進行操作。
責任編輯：林師授
來源：
伍華聰的博客
