管理标签
创建标签
- 请求说明
Https请求方式: POST
https://qyapi.weixin.qq.com/cgi-bin/tag/create?access_token=ACCESS_TOKEN
请求包结构体为:
{
"tagname": "UI",
"tagid": id
}
- 参数说明
| 参数 | 必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证 |
| tagname | 是 | 标签名称，长度限制为32个字（汉字或英文字母），标签名不可与其他标签重名。 |
| tagid | 否 | 标签id，整型，指定此参数时新增的标签会生成对应的标签id，不指定时则以目前最大的id自增。 |
- 权限说明
创建的标签属于管理组，默认为加锁状态。加锁状态下只有本管理组才可以增删成员，解锁状态下其它管理组也可以增删成员。
- 返回结果
{
"errcode": 0,
"errmsg": "created"
"tagid": 1
}
更新标签名字
- 请求说明
Https请求方式: POST
https://qyapi.weixin.qq.com/cgi-bin/tag/update?access_token=ACCESS_TOKEN
请求包示例如下:
{
"tagid": 1,
"tagname": "UI design"
}
- 参数说明
| 参数 | 必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证 |
| tagid | 是 | 标签ID |
| tagname | 是 | 标签名称，长度限制为32个字（汉字或英文字母），标签不可与其他标签重名。 |
- 权限说明
管理组必须是指定标签的创建者。
- 返回结果
{
"errcode": 0,
"errmsg": "updated"
}
删除标签
- 请求说明
Https请求方式: GET
https://qyapi.weixin.qq.com/cgi-bin/tag/delete?access_token=ACCESS_TOKEN&tagid=TAGID
- 参数说明
| 参数 | 必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证 |
| tagid | 是 | 标签ID |
- 权限说明
管理组必须是指定标签的创建者，并且标签的成员列表为空。
- 返回结果
{
"errcode": 0,
"errmsg": "deleted"
}
获取标签成员
- 请求说明
Https请求方式: GET
https://qyapi.weixin.qq.com/cgi-bin/tag/get?access_token=ACCESS_TOKEN&tagid=TAGID
- 参数说明
| 参数 | 必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证 |
| tagid | 是 | 标签ID |
- 权限说明
无限制，但返回列表仅包含管理组管辖范围的成员。
- 返回结果
{
"errcode": 0,
"errmsg": "ok",
"userlist": [
{
"userid": "zhangsan",
"name": "李四"
}
],
"partylist": [2]
}
| 参数 | 说明 |
|---|---|
| errcode | 错误码 |
| errmsg | 错误消息 |
| userlist | 成员列表 |
| userid | 成员UserID |
| name | 成员姓名 |
| partylist | 部门列表 |
增加标签成员
- 请求说明
Https请求方式: POST
https://qyapi.weixin.qq.com/cgi-bin/tag/addtagusers?access_token=ACCESS_TOKEN
请求包示例如下:
{
"tagid": 1,
"userlist":[ "user1","user2"],
"partylist": [4]
}
- 参数说明
| 参数 | 必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证 |
| tagid | 是 | 标签ID |
| userlist | 否 | 企业成员ID列表，注意：userlist、partylist不能同时为空，单次请求长度不超过1000 |
| partylist | 否 | 企业部门ID列表，注意：userlist、partylist不能同时为空，单次请求长度不超过100 |
- 权限说明
管理组是指定标签的创建者，或标签未加锁；成员属于管理组管辖范围。
- 返回结果
a)正确时返回
{
"errcode": 0,
"errmsg": "ok"
}
b)若部分userid、partylist非法，则返回
{
"errcode": 0,
"errmsg": "错误消息",
"invalidlist"："usr1|usr2|usr",
"invalidparty"：[2,4]
}
其中错误消息视具体出错情况而定，分别为：
invalid userlist and partylist faild
invalid userlist faild
invalid partylist faild
c)当包含userid、partylist全部非法时返回
{
"errcode": 40070,
"errmsg": "all list invalid "
}
| 参数 | 说明 |
|---|---|
| errcode | 错误码 |
| errmsg | 错误消息 |
| invalidlist | 不在权限内的成员ID列表，以“|”分隔 |
| invalidparty | 不在权限内的部门ID列表 |
删除标签成员
- 请求说明
Https请求方式: POST
https://qyapi.weixin.qq.com/cgi-bin/tag/deltagusers?access_token=ACCESS_TOKEN
请求包如下
{
"tagid": 1,
"userlist":[ "user1","user2"],
"partylist":[2,4]
}
- 参数说明
| 参数 | 必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证 |
| tagid | 是 | 标签ID |
| userlist | 否 | 企业成员ID列表，注意：userlist、partylist不能同时为空 |
| partylist | 否 | 企业部门ID列表，注意：userlist、partylist不能同时为空 |
- 权限说明
管理组是指定标签的创建者，或标签未加锁；成员属于管理组管辖范围。
- 返回结果
a)正确时返回
{
"errcode": 0,
"errmsg": "deleted"
}
b)若部分userid、partylist非法，则返回
{
"errcode": 0,
"errmsg": "错误消息",
"invalidlist"："usr1|usr2|usr",
"invalidparty": [2,4]
}
其中错误消息视具体出错情况而定，分别为：
invalid userlist and partylist faild
invalid userlist faild
invalid partylist faild
c)当包含的userid、partylist全部非法时返回
{
"errcode": 40031,
"errmsg": "all list invalid"
}
| 参数 | 说明 |
|---|---|
| errcode | 错误码 |
| errmsg | 错误消息 |
| invalidlist | 不在权限内的或者非法的成员ID列表，以“|”分隔 |
| invalidparty | 不在权限内的部门ID列表 |
获取标签列表
- 请求说明
Https请求方式: GET
https://qyapi.weixin.qq.com/cgi-bin/tag/list?access_token=ACCESS_TOKEN
- 参数说明
| 参数 | 必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证 |
- 权限说明
无
- 返回结果
{
"errcode": 0,
"errmsg": "ok",
"taglist":[
{"tagid":1,"tagname":"a"},
{"tagid":2,"tagname":"b"}
]
}