企业微信应用开发中, 重要的的地方就在于可以可以管理企业微信中的成员信息, 同步成员信息,也可以进行成员的管理。
本系列,主要说下成员管理中用到的操作,跟各操作的用法。
一、 创建成员
二、 读取成员
三、 更新成员
四、 删除成员
更新成员
请求方式:POST(HTTPS)
请求地址:https://qyapi.weixin.qq.com/cgi-bin/user/update?access_token=ACCESS_TOKEN
请求包体:
[C#] 纯文本查看 复制代码
{
"userid": "zhangsan",
"name": "李四",
"department": [1],
"order": [10],
"position": "后台工程师",
"mobile": "13800000000",
"gender": "1",
"email": "zhangsan@gzdev.com",
"is_leader_in_dept": [1],
"enable": 1,
"avatar_mediaid": "2-G6nrLmr5EC3MNb_-zL1dDdzkd0p7cNliYu9V5w7o8K0",
"telephone": "020-123456",
"alias": "jackzhang",
"address": "广州市海珠区新港中路",
"main_department": 1,
"extattr": {
"attrs": [
{
"type": 0,
"name": "文本名称",
"text": {
"value": "文本"
}
},
{
"type": 1,
"name": "网页名称",
"web": {
"url": "http://www.test.com",
"title": "标题"
}
}
]
},
"external_position": "工程师",
"external_profile": {
"external_corp_name": "企业简称",
"wechat_channels": {
"nickname": "视频号名称",
},
"external_attr": [
{
"type": 0,
"name": "文本名称",
"text": {
"value": "文本"
}
},
{
"type": 1,
"name": "网页名称",
"web": {
"url": "http://www.test.com",
"title": "标题"
}
},
{
"type": 2,
"name": "测试app",
"miniprogram": {
"appid": "wx8bd80126147dFAKE",
"pagepath": "/index",
"title": "my miniprogram"
}
}
]
}
}
请求包体参数说明:
[C#] 纯文本查看 复制代码
参数 必须 说明
1. access_token 是 调用接口凭证
2. userid 是 成员UserID。对应管理端的帐号,企业内必须唯一。不区分大小写,长度为1~64个字节
3. name 否 成员名称。长度为1~64个utf8字符
4. alias 否 别名。长度为1-32个utf8字符
5. mobile 否 手机号码。企业内必须唯一。若成员已激活企业微信,则需成员自行修改(此情况下该参数被忽略,但不会报错)
6. department 否 成员所属部门id列表,不超过100个
7. order 否 部门内的排序值,默认为0。当有传入department时有效。数量必须和department一致,数值越大排序越前面。有效的值范围是[0, 2^32)
8. position 否 职务信息。长度为0~128个字符
9. gender 否 性别。1表示男性,2表示女性
10. email 否 邮箱。长度不超过64个字节,且为有效的email格式。企业内必须唯一。若是绑定了腾讯企业邮箱的企业微信,则需要在腾讯企业邮箱中修改邮箱(此情况下该参数被忽略,但不会报错)
11. telephone 否 座机。由1-32位的纯数字、“-”、“+”或“,”组成
12. is_leader_in_dept 否 上级字段,个数必须和department一致,表示在所在的部门内是否为上级。
13. avatar_mediaid 否 成员头像的mediaid,通过素材管理接口上传图片获得的mediaid
14. enable 否 启用/禁用成员。1表示启用成员,0表示禁用成员
15. extattr 否 自定义字段。自定义字段需要先在WEB管理端添加,见扩展属性添加方法,否则忽略未知属性的赋值。与对外属性一致,不过只支持type=0的文本和type=1的网页类型,详细描述查看对外属性
16. external_profile 否 成员对外属性,字段详情见对外属性
17. external_position 否 对外职务,如果设置了该值,则以此作为对外展示的职务,否则以position来展示。不超过12个汉字
18. nickname 否 视频号名字(设置后,成员将对外展示该视频号)。须从企业绑定到企业微信的视频号中选择,可在“我的企业”页中查看绑定的视频号
19. address 否 地址。长度最大128个字符
20. main_department 否 主部门
接口请求返回结果:
[C#] 纯文本查看 复制代码
{
"errcode": 0,
"errmsg": "updated"
}
返回结果参数说明:
参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
特别地,如果userid由系统自动生成,则仅允许修改一次。新值可由new_userid字段指定。
权限说明:
仅通讯录同步助手或第三方通讯录应用可调用。
注意,每个部门下的部门、成员总数不能超过3万个。
|