该接口用于一次性读取指定类型的通讯录隐藏规则列表
请求方式: POST(HTTPS)
请求地址: https://qyapi.weixin.qq.com/cgi-bin/contactrule/list?access_token=ACCESS_TOKEN
参数说明:
| 参数 | 是否必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证。仅通讯录同步应用的 access_token 可调用该接口 |
权限说明:
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"rules": [
{
"rule_id": 10001,
"rule_type": 1,
"range": {
"userid": ["zhangsan", "lisi"],
"partyid": [1, 2],
"tagid": [3]
},
"whitelist": {
"userid": ["wangwu"],
"partyid": [4],
"tagid": []
}
}
]
}
返回参数说明:
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| rules | 通讯录隐藏规则列表 |
| rules.rule_id | 规则唯一标识 |
| rules.rule_type | 规则类型。 1 - 隐藏部门/成员 2 - 限制查看外部门 3 - 限制查看所有人 |
| rules.range | 规则目标范围,被隐藏或受限的部门、成员、标签 |
| rules.range.userid | 成员 ID 列表 |
| rules.range.partyid | 部门 ID 列表 |
| rules.range.tagid | 标签 ID 列表 |
| rules.whitelist | 白名单范围,允许查看的部门、成员、标签 |
| rules.exclude | 排除名单范围,不受该规则限制的部门、成员、标签 |
| rules.is_allowed_search | 是否允许搜索 |
| rules.is_allowed_conversation | 是否允许会话 |
