企业微信php成员管理,管理成员

创建成员

请求说明

Https请求方式: POST

请求包结构体为:

{

"userid": "zhangsan",

"name": "张三",

"department": [1, 2],

"position": "产品经理",

"mobile": "15913215421",

"gender": "1",

"email": "zhangsan@gzdev.com",

"weixinid": "zhangsan4dev",

"avatar_mediaid": "2-G6nrLmr5EC3MNb_-zL1dDdzkd0p7cNliYu9V5w7o8K0",

"extattr": {"attrs":[{"name":"爱好","value":"旅游"},{"name":"卡号","value":"1234567234"}]}

}

参数说明

参数

必须

说明

access_token

是

调用接口凭证

userid

是

成员UserID。对应管理端的帐号，企业内必须唯一。不区分大小写，长度为1~64个字节

name

是

成员名称。长度为1~64个字节

department

是

成员所属部门id列表,不超过20个

position

否

职位信息。长度为0~64个字节

mobile

否

手机号码。企业内必须唯一，mobile/weixinid/email三者不能同时为空

gender

否

性别。1表示男性，2表示女性

email

否

邮箱。长度为0~64个字节。企业内必须唯一

weixinid

否

微信号。企业内必须唯一。(注意：是微信号，不是微信的名字)

avatar_mediaid

否

成员头像的mediaid，通过多媒体接口上传图片获得的mediaid

extattr

否

扩展属性。扩展属性需要在WEB管理端创建后才生效，否则忽略未知属性的赋值

权限说明

管理组须拥有指定部门的管理权限。

返回结果

{

"errcode": 0,

"errmsg": "created"

}

更新成员

请求说明

Https请求方式: POST

请求包示例如下(如果非必须的字段未指定，则不更新该字段之前的设置值):

{

"userid": "zhangsan",

"name": "李四",

"department": [1],

"position": "后台工程师",

"mobile": "15913215421",

"gender": "1",

"email": "zhangsan@gzdev.com",

"weixinid": "lisifordev",

"enable": 1,

"avatar_mediaid": "2-G6nrLmr5EC3MNb_-zL1dDdzkd0p7cNliYu9V5w7o8K0",

"extattr": {"attrs":[{"name":"爱好","value":"旅游"},{"name":"卡号","value":"1234567234"}]}

}

参数说明

参数

必须

说明

access_token

是

调用接口凭证

userid

是

成员UserID。对应管理端的帐号，企业内必须唯一。长度为1~64个字节

name

否

成员名称。长度为0~64个字节

department

否

成员所属部门id列表，不超过20个

position

否

职位信息。长度为0~64个字节

mobile

否

手机号码。企业内必须唯一，mobile/weixinid/email三者不能同时为空

gender

否

性别。1表示男性，2表示女性

email

否

邮箱。长度为0~64个字节。企业内必须唯一

weixinid

否

微信号。企业内必须唯一。(注意：是微信号，不是微信的名字)

enable

否

启用/禁用成员。1表示启用成员，0表示禁用成员

avatar_mediaid

否

成员头像的mediaid，通过多媒体接口上传图片获得的mediaid

extattr

否

扩展属性。扩展属性需要在WEB管理端创建后才生效，否则忽略未知属性的赋值

权限说明

管理组须拥有指定部门、成员的管理权限。

返回结果

{

"errcode": 0,

"errmsg": "updated"

}

删除成员

请求说明

Https请求方式: GET

参数说明

参数

必须

说明

access_token

是

调用接口凭证

userid

是

成员UserID。对应管理端的帐号

权限说明

管理组须拥有指定成员的管理权限。

返回结果

{

"errcode": 0,

"errmsg": "deleted"

}

批量删除成员

请求说明

Https请求方式: POST

请求包结构体为:

{

"useridlist": ["zhangsan", "lisi"]

}

参数说明

参数

必须

说明

access_token

是

调用接口凭证

useridlist

是

成员UserID列表。对应管理端的帐号。(最多支持200个)

权限说明

管理组须拥有指定成员的管理权限。

返回结果

{

"errcode": 0,

"errmsg": "deleted"

}

获取成员

请求说明

Https请求方式: GET

参数说明

参数

必须

说明

access_token

是

调用接口凭证

userid

是

成员UserID。对应管理端的帐号

权限说明

管理组须拥有指定成员的查看权限。

返回结果

{

"errcode": 0,

"errmsg": "ok",

"userid": "zhangsan",

"name": "李四",

"department": [1, 2],

"position": "后台工程师",

"mobile": "15913215421",

"gender": "1",

"email": "zhangsan@gzdev.com",

"weixinid": "lisifordev",

"avatar": "http://wx.qlogo.cn/mmopen/ajNVdqHZLLA3WJ6DSZUfiakYe37PKnQhBIeOQBO4czqrnZDS79FH5Wm5m4X69TBicnHFlhiafvDwklOpZeXYQQ2icg/0",

"status": 1,

"extattr": {"attrs":[{"name":"爱好","value":"旅游"},{"name":"卡号","value":"1234567234"}]}

}

参数

说明

errcode

返回码

errmsg

对返回码的文本描述内容

userid

成员UserID。对应管理端的帐号

name

成员名称

department

成员所属部门id列表

position

职位信息

mobile

手机号码。第三方仅通讯录套件可获取

gender

性别。0表示未定义，1表示男性，2表示女性

email

邮箱。第三方仅通讯录套件可获取

weixinid

微信号

avatar

头像url。注：如果要获取小图将url最后的"/0"改成"/64"即可

status

关注状态: 1=已关注，2=已禁用，4=未关注

extattr

扩展属性。第三方仅通讯录套件可获取

获取部门成员

请求说明

Https请求方式: GET

参数说明

参数

必须

说明

access_token

是

调用接口凭证

department_id

是

获取的部门id

fetch_child

否

1/0：是否递归获取子部门下面的成员

status

否

0获取全部成员，1获取已关注成员列表，2获取禁用成员列表，4获取未关注成员列表。status可叠加，未填写则默认为4

权限说明

管理组须拥有指定部门的查看权限。

返回结果

{

"errcode": 0,

"errmsg": "ok",

"userlist": [

{

"userid": "zhangsan",

"name": "李四",

"department": [1, 2]

}

]

}

参数

说明

errcode

返回码

errmsg

对返回码的文本描述内容

userlist

成员列表

userid

成员UserID。对应管理端的帐号

name

成员名称

department

成员所属部门

获取部门成员(详情)

请求说明

Https请求方式: GET

参数说明

参数

必须

说明

access_token

是

调用接口凭证

department_id

是

获取的部门id

fetch_child

否

1/0：是否递归获取子部门下面的成员

status

否

0获取全部成员，1获取已关注成员列表，2获取禁用成员列表，4获取未关注成员列表。status可叠加,未填写则默认为4

权限说明

管理组须拥有指定部门的查看权限。

返回结果

{

"errcode": 0,

"errmsg": "ok",

"userlist": [

{

"userid": "zhangsan",

"name": "李四",

"department": [1, 2],

"position": "后台工程师",

"mobile": "15913215421",

"gender": "1",

"email": "zhangsan@gzdev.com",

"weixinid": "lisifordev",

"avatar": "http://wx.qlogo.cn/mmopen/ajNVdqHZLLA3WJ6DSZUfiakYe37PKnQhBIeOQBO4czqrnZDS79FH5Wm5m4X69TBicnHFlhiafvDwklOpZeXYQQ2icg/0",

"status": 1,

"extattr": {"attrs":[{"name":"爱好","value":"旅游"},{"name":"卡号","value":"1234567234"}]}

}

]

}

参数

说明

errcode

返回码

errmsg

对返回码的文本描述内容

userlist

成员列表

userid

成员UserID。对应管理端的帐号

name

成员名称

department

成员所属部门id列表

position

职位信息

mobile

手机号码。第三方仅通讯录套件可获取

gender

性别。0表示未定义，1表示男性，2表示女性

email

邮箱。第三方仅通讯录套件可获取

weixinid

微信号

avatar

头像url。注：如果要获取小图将url最后的"/0"改成"/64"即可

status

关注状态: 1=已关注，2=已冻结，4=未关注

extattr

扩展属性。第三方仅通讯录套件可获取