How to manage contacts in WeChat Enterprise Account Development

The enterprise address book has completely open interfaces, and your applications can call these interfaces to manage departments, members, and tags.

Your app can also send messages using departments, members, or tags, or change the visibility of your app.

Please note that the upper limit of the number of direct employees in each department is 1,000 ; for security reasons, some interfaces require explicit authorization on the management side .

1. Management Department

1. Create a department

• Request Instructions

Https request method: POST

https://qyapi.weixin.qq.com/cgi-bin/department/create?access_token=ACCESS_TOKEN

The request packet structure is:

 {
 "name" : "Mailbox Product Group" ,
 "parentid" : "1"  
 }

• Parameter Description

• Permissions

The administrator must have the interface permission of "Operate Address Book" and the management permission of the parent department.

• Return results

 {
 "errcode" : 0 ,
 "errmsg" : "created" ,
 "id" : 2  
 } 

2. Update department

• Request Instructions

Https request method: POST

https://qyapi.weixin.qq.com/cgi-bin/department/update?access_token=ACCESS_TOKEN

The request packet structure is (if a non-required field is not specified, the previous setting value of the field will not be updated):

 {
 "id" : 2 ,
 "name" : "Mailbox Product Department"  
 }

• Parameter Description

• Permissions

The administrator must have the interface permission of "Operate Address Book" and the management permission of the department.

• Return results

 {
 "errcode" : 0 ,
 "errmsg" : "updated"  
 }

3. Delete a department

• Request Instructions

Https request method: GET

https://qyapi.weixin.qq.com/cgi-bin/department/delete?access_token=ACCESS_TOKEN&id=1&id=2

• Parameter Description

• Permissions

The administrator must have the interface permission of "Operate Address Book" and the management permission of the department.

• Return results

 {
 "errcode" : 0 ,
 "errmsg" : "deleted"  
 }

4. Get the department list

• Request Instructions

Https request method: GET

https://qyapi.weixin.qq.com/cgi-bin/department/list?access_token=ACCESS_TOKEN

• Parameter Description

• Permissions

The administrator must have the interface permission to 'get department list' and the permission to view departments.

• Return results

 {
 "errcode" : 0 ,
 "errmsg" : "ok" ,
 "department" : [
 {
 "id" : 1 ,
 "name" : "Guangzhou R&D Center" ,
 "parentid" : 0  
 },
 {
 "id" : 2  
 "name" : "Mailbox Product Department" ,
 "parentid" : 1  
 }
 ]
 } 

#p#

2. Management members

1. Create members

• Request Instructions

Https request method: POST

https://qyapi.weixin.qq.com/cgi-bin/user/create?access_token=ACCESS_TOKEN

The request packet structure is:

 {
 "userid" : "zhangsan" ,
 "name" : "Zhang San" ,
 "department" : [ 1 , 2 ],
 "position" : "Product Manager" ,
 "mobile" : "15913215421" ,
 "gender" : 1 ,
 "tel" : "62394" ,
 "email" : "[email protected]" ,
 "weixinid" : "zhangsan4dev"  
 }

• Parameter Description

• Permissions

The administrator must have the interface permission to "operate the address book" and the management permission for the designated department.

• Return results

 {
 "errcode" : 0 ,
 "errmsg" : "created"  
 }

2. Update members

• Request Instructions

Https request method: POST

https://qyapi.weixin.qq.com/cgi-bin/user/update?access_token=ACCESS_TOKEN

The request packet example is as follows (if a non-required field is not specified, the previous setting value of the field will not be updated):

 {
 "userid" : "zhangsan" ,
 "name" : "Li Si" ,
 "department" : [1],
 "position" : "Backend Engineer" ,
 "mobile" : "15913215421" ,
 "gender" : 1,
 "tel" : "62394" ,
 "email" : "[email protected]" ,
 "weixinid" : "lisifordev" ,
 "enable" : 1
 }

• Parameter Description

• Permissions

Administrators must have interface permissions for "operating the address book" and management permissions for designated departments and members.

• Return results

 {
 "errcode" : 0 ,
 "errmsg" : "updated"  
 }

3. Delete members

• Request Instructions

Https request method: GET

https://qyapi.weixin.qq.com/cgi-bin/user/delete?access_token=ACCESS_TOKEN&userid=lisi

• Parameter Description

• Permissions

Administrators must have interface permissions for "operating the address book" and management permissions for designated departments and members.

• Return results

 {
 "errcode" : 0 ,
 "errmsg" : "deleted"  
 }

4. Get members

• Request Instructions

Https request method: GET

https://qyapi.weixin.qq.com/cgi-bin/user/get?access_token=ACCESS_TOKEN&userid=lisi

• Parameter Description

• Return results

 {
 "errcode" : 0 ,
 "errmsg" : "ok" ,
 "userid" : "zhangsan" ,
 "name" : "Li Si" ,
 "department" : [ 1 , 2 ],
 "position" : "Backend Engineer" ,
 "mobile" : "15913215421" ,
 "gender" : 1 ,
 "tel" : "62394" ,
 "email" : "[email protected]" ,
 "weixinid" : "lisifordev" ,
 "avatar" : "http://wx.qlogo.cn/mmopen/ajNVdqHZLLA3WJ6DSZUfiakYe37PKnQhBIeOQBO4czqrnZDS79FH5Wm5m4X69TBicnHFlhiafvDwklOpZeXYQQ2icg/0" ,
 "status" : 1  
 } 

• Permissions

Administrators must have the 'Get Members' interface permission and the member viewing permission.

5. Get department members

• Request Instructions

Https request method: GET

https://qyapi.weixin.qq.com/cgi-bin/user/simplelist?access_token=ACCESS_TOKEN&department_id=1&fetch_child=0&status=0

• Parameter Description

• Permissions

Administrators must have the interface permission to 'get department members' and the viewing permission for the specified department.

• Return results

 {
 "errcode" : 0 ,
 "errmsg" : "ok" ,
 "userlist" : [
 {
 "userid" : "zhangsan" ,
 "name" : "Li Si"  
 }
 ]
 } 

#p#

3. Manage Tags

1. Create tags

• Request Instructions

Https request method: POST

https://qyapi.weixin.qq.com/cgi-bin/tag/create?access_token=ACCESS_TOKEN

Note: The tag lock is unlocked by default.

The request packet structure is:

 {
 "tagname" : "UI"  
 }

• Parameter Description

• Permissions

No limitation.

• Return results

 {
 "errcode" : 0 ,
 "errmsg" : "created"  
 "tagid" : "1"  
 }

2. Update the label name

• Request Instructions

Https request method: POST

https://qyapi.weixin.qq.com/cgi-bin/tag/update?access_token=ACCESS_TOKEN

The following is an example of a request packet:

 {
 "tagid" : "1" ,
 "tagname" : "UI design"  
 }

• Parameter Description

• Permissions

The administrator must be the creator of the specified tag.

• Return results

 {
 "errcode" : 0 ,
 "errmsg" : "updated"  
 }

3. Delete tags

• Request Instructions

Https request method: GET

https://qyapi.weixin.qq.com/cgi-bin/tag/delete?access_token=ACCESS_TOKEN&tagid=1

• Parameter Description

• Permissions

The administrator must be the creator of the specified tag, and the member list of the tag must be empty.

• Return results

 {
 "errcode" : 0 ,
 "errmsg" : "deleted"  
 }

4. Get tag members

• Request Instructions

Https request method: GET

https://qyapi.weixin.qq.com/cgi-bin/tag/get?access_token=ACCESS_TOKEN&tagid=1

• Parameter Description

• Permissions

The administrator must have the "Get Tag Members" interface permission, and the tag must be visible to the administrator; the returned list only includes members under the administrator's jurisdiction.

• Return results

 {
 "errcode" : 0 ,
 "errmsg" : "ok" ,
 "userlist" : [
 {
 "userid" : "zhangsan" ,
 "name" : "Li Si"  
 }
 ]
 } 

5. Add tag members

• Request Instructions

Https request method: POST

https://qyapi.weixin.qq.com/cgi-bin/tag/addtagusers?access_token=ACCESS_TOKEN

The following is an example of a request packet:

 {
 "tagid" : "1" ,
 "userlist" :[ "user1" , "user2" ]
 }

• Parameter Description

• Permissions

Tags are visible to administrators and are not locked, and members are under the administrator's jurisdiction.

• Return results

a) Return if correct

 {
 "errcode" : 0 ,
 "errmsg" : "ok"  
 }

b) If part of the userid is illegal, return

 {
 "errcode" : 0 ,
 "errmsg" : "invalid userlist failed"  
 "invalidlist" : "usr1|usr2|usr"  
 }

c) Return when all the userids are invalid

 {
 "errcode" : 40070 ,
 "errmsg" : "all list invalid "  
 } 

6. Delete tag members

• Request Instructions

Https request method: POST

https://qyapi.weixin.qq.com/cgi-bin/tag/deltagusers?access_token=ACCESS_TOKEN

The request packet is as follows

 {
 "tagid" : "1" ,
 "userlist" :[ "user1" , "user2" ]
 }

• Parameter Description

• Permissions

Tags are visible to administrators and are not locked, and members are under the administrator's jurisdiction.

• Return results

a) Return if correct

 {
 "errcode" : 0 ,
 "errmsg" : "deleted"  
 }

b) If part of the userid is illegal, return

 {
 "errcode" : 0 ,
 "errmsg" : "invalid userlist failed"  
 "invalidlist" : "usr1|usr2|usr"  
 }

c) Return when all the contained userids are invalid

 {
 "errcode" : 40031 ,
 "errmsg" : "all list invalid"  
 }