C#開發微信入口網站及應用微信企業號的通訊錄管理開發之成員管理
- 高洛峰原創
- 2017-03-02 09:41:013204瀏覽
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。對應管理端的帳號，企業內必須唯一。長度為1~64個字元 | |
| 是 | 成員名稱。長度為1~64個字元 | |
| 否 | 成員所屬部門id列表。請注意，每個部門的直屬員工上限為1000個 | |
| 否 | 職位資訊。長度為0~64個字元 | |
| #否 | 手機號碼。企業內必須唯一，mobile/weixinid/email三者不能同時為空 | |
| 否 | #性別。 gender=0表示男，=1表示女。預設gender=0 | |
| #辦公室電話。長度為0~64個字元 | ||
| 否 | 郵件信箱。長度為0~64個字元。企業內必須唯一 |
- 否
微訊號。企業內必須唯一
- 權限說明
{
"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 = "http://www.php.cn/{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要求方式: POSThttps://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 = "http://www.php.cn/{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
| 必須 | ||
| 是 | 呼叫介面憑證 |
返回结果
{
"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
https://qyapi.weixin.qq.com/cgi-bin/user/simplelist?access_token=ACCESS_TOKEN&department_id=1&fetch_child=0&status=0
参数说明
| 参数 | 必须 | 说明 |
|---|---|---|
| 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; }
}</corpusersimplejson></corpusersimplejson>
7、综合例子调用代码
上面介绍了一些企业号的接口定义和我对API的C#封装接口和部分实现代码，实现了功能后，我们就可以在代码中对它进行测试，确信是否正常使用。
/// <summary>
/// 人员管理综合性操作（创建、修改、获取信息、删除） /// </summary>
/// <param>
/// <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);
}
}
}</int>
获取部门人员的操作代码如下所示。
/// <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);
}
}
}
人员的管理，相对来说比较简单，主要是在一定的部门下创建人员，然后也可以给标签增加相应的人员，基本上就是这些了，不过一定需要确保有相应的权限进行操作。
更多C#開發微信入口網站及應用微信企業號的通訊錄管理開發之成員管理相关文章请关注PHP中文网！
陳述：
本文內容由網友自願投稿，版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容，請聯絡admin@php.cn