微信企業(yè)號(hào)的通訊錄管理開(kāi)發(fā)之成員管理
在上篇隨筆《微信企業(yè)號(hào)的通訊錄管理開(kāi)發(fā)之部門(mén)管理》介紹了通訊錄的部門(mén)的相關(guān)操作管理，通訊錄管理包括部門(mén)管理、成員管理、標(biāo)簽管理三個(gè)部分，本篇主要介紹成員的管理操作，包括創(chuàng)建、刪除、更新、獲取、獲取部門(mén)成員幾個(gè)操作要點(diǎn)。
1、成員的創(chuàng)建操作
為了方便，我們可以創(chuàng)建一個(gè)部門(mén)組織結(jié)構(gòu)，這是開(kāi)發(fā)的前提，因?yàn)槲覀兺ㄓ嶄浌芾?，也是基于一個(gè)組織機(jī)構(gòu)下的，如上篇介紹的組織結(jié)構(gòu)層次一樣。我這里創(chuàng)建一個(gè)廣州愛(ài)奇迪的根結(jié)構(gòu)，然后在其中在創(chuàng)建一些組織機(jī)構(gòu)，如下圖所示。
在后臺(tái)可以通過(guò)功能操作添加人員，本篇主要介紹如何調(diào)用微信企業(yè)號(hào)API進(jìn)行人員管理的操作。
創(chuàng)建人員的API定義如下所示。
- 請(qǐng)求說(shuō)明
Https請(qǐng)求方式: POST
https://qyapi.weixin.qq.com/cgi-bin/user/create?access_token=ACCESS_TOKEN
請(qǐng)求包結(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ù)說(shuō)明
| 參數(shù) | 必須 | 說(shuō)明 |
|---|---|---|
| access_token | 是 | 調(diào)用接口憑證 |
| userid | 是 | 員工UserID。對(duì)應(yīng)管理端的帳號(hào)，企業(yè)內(nèi)必須***。長(zhǎng)度為1~64個(gè)字符 |
| name | 是 | 成員名稱(chēng)。長(zhǎng)度為1~64個(gè)字符 |
| department | 否 | 成員所屬部門(mén)id列表。注意，每個(gè)部門(mén)的直屬員工上限為1000個(gè) |
| position | 否 | 職位信息。長(zhǎng)度為0~64個(gè)字符 |
| mobile | 否 | 手機(jī)號(hào)碼。企業(yè)內(nèi)必須***，mobile/weixinid/email三者不能同時(shí)為空 |
| gender | 否 | 性別。gender=0表示男，=1表示女。默認(rèn)gender=0 |
| tel | 否 | 辦公電話。長(zhǎng)度為0~64個(gè)字符 |
| 否 | 郵箱。長(zhǎng)度為0~64個(gè)字符。企業(yè)內(nèi)必須*** | |
| weixinid | 否 | 微信號(hào)。企業(yè)內(nèi)必須*** |
- 權(quán)限說(shuō)明
管理員須擁有“操作通訊錄”的接口權(quán)限，以及指定部門(mén)的管理權(quán)限。
- 返回結(jié)果
- {
- "errcode": 0,
- "errmsg": "created"
- }
我們?cè)贑#里面，需要定義對(duì)應(yīng)給的接口，然后根據(jù)需要構(gòu)造對(duì)應(yīng)的傳遞實(shí)體信息。
這里我把人員管理的接口全部定義好，接口定義如下所示。
- #region 部門(mén)成員管理
- /// <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>
- /// 獲取部門(mén)成員
- /// </summary>
- CorpUserListJson GetDeptUser(string accessToken, int department_id, int fetch_child = 0, int status = 0);
- #endregion
然后根據(jù)信息定義，創(chuàng)建一個(gè)承載人員信息的CorpUserJson實(shí)體對(duì)象，創(chuàng)建人員的實(shí)現(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)建操作類(lèi)似，它的企業(yè)號(hào)定義如下所示。
- 請(qǐng)求說(shuō)明
Https請(qǐng)求方式: POST
https://qyapi.weixin.qq.com/cgi-bin/user/update?access_token=ACCESS_TOKEN
請(qǐng)求包示例如下（如果非必須的字段未指定，則不更新該字段之前的設(shè)置值）:
- {
- "userid": "zhangsan",
- "name": "李四",
- "department": [1],
- "position": "后臺(tái)工程師",
- "mobile": "15913215421",
- "gender": 1,
- "tel": "62394",
- "email": "zhangsan@gzdev.com",
- "weixinid": "lisifordev",
- "enable": 1
- }
由于它的操作數(shù)據(jù)類(lèi)似，因此它的實(shí)現(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、成員的刪除、成員的獲取、部門(mén)成員的獲取操作
這些操作和上面的類(lèi)似，不在贅述，主要就是根據(jù)需要定義他們對(duì)應(yīng)的返回?cái)?shù)據(jù)信息，然后解析Json數(shù)據(jù)即可轉(zhuǎn)換為對(duì)應(yīng)的實(shí)體。
1）刪除人員的定義如下：
- 請(qǐng)求說(shuō)明
Https請(qǐng)求方式: GET
https://qyapi.weixin.qq.com/cgi-bin/user/delete?access_token=ACCESS_TOKEN&userid=lisi
- 參數(shù)說(shuō)明
| 參數(shù) | 必須 | 說(shuō)明 |
|---|---|---|
| access_token | 是 | 調(diào)用接口憑證 |
| userid | 是 | 員工UserID。對(duì)應(yīng)管理端的帳號(hào) |
- 返回結(jié)果
{
"errcode": 0,
"errmsg": "deleted"
}
2）成員的獲取定義如下：
- 請(qǐng)求說(shuō)明
Https請(qǐng)求方式: GET
https://qyapi.weixin.qq.com/cgi-bin/user/get?access_token=ACCESS_TOKEN&userid=lisi
- 參數(shù)說(shuō)明
| 參數(shù) | 必須 | 說(shuō)明 |
|---|---|---|
| access_token | 是 | 調(diào)用接口憑證 |
| userid | 是 | 員工UserID |
- 返回結(jié)果
{
"errcode": 0,
"errmsg": "ok",
"userid": "zhangsan",
"name": "李四",
"department": [1, 2],
"position": "后臺(tái)工程師",
"mobile": "15913215421",
"gender": 1,
"tel": "62394",
"email": "zhangsan@gzdev.com",
"weixinid": "lisifordev",
"avatar": "http://wx.qlogo.cn/mmopen/ajNVdqHZLLA3WJ6DSZUfiakYe37PKnQhBIeOQBO4czqrnZDS79FH5Wm5m4X69TBicnHFlhiafvDwklOpZeXYQQ2icg/0",
"status": 1
}
3）部門(mén)成員的獲取定義如下：
- 請(qǐng)求說(shuō)明
Https請(qǐng)求方式: GET
- 參數(shù)說(shuō)明
| 參數(shù) | 必須 | 說(shuō)明 |
|---|---|---|
| access_token | 是 | 調(diào)用接口憑證 |
| department_id | 是 | 獲取的部門(mén)id |
| fetch_child | 否 | 1/0：是否遞歸獲取子部門(mén)下面的成員 |
| status | 否 | 0獲取全部員工，1獲取已關(guān)注成員列表，2獲取禁用成員列表，4獲取未關(guān)注成員列表。status可疊加 |
- 權(quán)限說(shuō)明
管理員須擁有’獲取部門(mén)成員’的接口權(quán)限，以及指定部門(mén)的查看權(quán)限。
- 返回結(jié)果
- {
- "errcode": 0,
- "errmsg": "ok",
- "userlist": [
- {
- "userid": "zhangsan",
- "name": "李四"
- }
- ]
- }
這個(gè)返回值我們定義一個(gè)實(shí)體對(duì)象用來(lái)存儲(chǔ)數(shù)據(jù)即可。
- /// <summary>
- /// 獲取部門(mén)成員返回的數(shù)據(jù)
- /// </summary>
- public class CorpUserListJson : BaseJsonResult
- {
- public CorpUserListJson()
- {
- this.userlist = new List<CorpUserSimpleJson>();
- }
- /// <summary>
- /// 返回的錯(cuò)誤消息
- /// </summary>
- public CorpReturnCode errcode { get; set; }
- /// <summary>
- /// 對(duì)返回碼的文本描述內(nèi)容
- /// </summary>
- public string errmsg { get; set; }
- /// <summary>
- /// 成員列表
- /// </summary>
- public List<CorpUserSimpleJson> userlist { get; set; }
- }
7、綜合例子調(diào)用代碼
上面介紹了一些企業(yè)號(hào)的接口定義和我對(duì)API的C#封裝接口和部分實(shí)現(xiàn)代碼，實(shí)現(xiàn)了功能后，我們就可以在代碼中對(duì)它進(jìn)行測(cè)試，確信是否正常使用。
- /// <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 ="測(cè)試用戶";
- 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 = "修改測(cè)試";
- user.name = name;
- CorpUserUpdateJson userUpdate = new CorpUserUpdateJson(user);
- result = bll.UpdateUser(token, userUpdate);
- if (result != null)
- {
- Console.WriteLine("修改名稱(chēng):{0} {1} {2}", name, (result.Success ? "成功" : "失敗"), result.ErrorMessage);
- }
- CorpUserGetJson userGet = bll.GetUser(token, user.userid);
- if (userGet != null)
- {
- Console.WriteLine("成員名稱(chēng):{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);
- }
- }
- }
獲取部門(mén)人員的操作代碼如下所示。
- /// <summary>
- /// 獲取部門(mén)人員
- /// </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("成員名稱(chēng):{0} {1}", item.name, item.userid);
- }
- }
- }
人員的管理，相對(duì)來(lái)說(shuō)比較簡(jiǎn)單，主要是在一定的部門(mén)下創(chuàng)建人員，然后也可以給標(biāo)簽增加相應(yīng)的人員，基本上就是這些了，不過(guò)一定需要確保有相應(yīng)的權(quán)限進(jìn)行操作。
