该接口用于批量创建通讯录隐藏规则。规则范围使用 userid、partyid、tagid 表达,可用于隐藏部门/成员、限制查看外部门、限制查看所有人等场景。
请求方式: POST(HTTPS)
请求地址: https://qyapi.weixin.qq.com/cgi-bin/contactrule/create?access_token=ACCESS_TOKEN
请求包体:
{
"rules": [
{
"rule_type": 1,
"range": {
"userid": ["zhangsan", "lisi"],
"partyid": [1, 2],
"tagid": [3]
},
"whitelist": {
"userid": ["wangwu"],
"partyid": [4],
"tagid": []
}
}
]
}
参数说明:
| 参数 | 是否必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证。仅通讯录同步应用的 access_token 可调用该接口 |
| rules | 是 | 要创建的规则列表,最多支持 100 条 |
| rules.rule_type | 是 | 规则类型。 1 - 隐藏部门/成员 2 - 限制查看外部门 3 - 限制查看所有人 |
| rules.range | 是 | 规则目标范围,被隐藏或受限的部门、成员、标签 |
| rules.range.userid | 否 | 成员 ID 列表,最多支持 1000 个成员 |
| rules.range.partyid | 否 | 部门 ID 列表,最多支持 100 个部门 |
| rules.range.tagid | 否 | 标签 ID 列表,最多支持 100 个标签 |
| rules.whitelist | 否 | 白名单范围,允许查看的部门、成员、标签 |
| rules.whitelist.userid | 否 | 白名单成员 ID 列表,最多支持 1000 个成员 |
| rules.whitelist.partyid | 否 | 白名单部门 ID 列表,最多支持 100 个部门 |
| rules.whitelist.tagid | 否 | 白名单标签 ID 列表,最多支持 100 个标签 |
| rules.exclude | 否 | 排除名单范围,不受该规则限制的部门、成员、标签。限制查看外部门/所有人时使用 |
| rules.exclude.userid | 否 | 排除名单成员 ID 列表,最多支持 1000 个成员 |
| rules.exclude.partyid | 否 | 排除名单部门 ID 列表,最多支持 100 个部门 |
| rules.exclude.tagid | 否 | 排除名单标签 ID 列表,最多支持 100 个标签 |
| rules.is_allowed_search | 否 | 是否允许搜索。限制查看外部门/所有人时使用 |
| rules.is_allowed_conversation | 否 | 是否允许会话。限制查看外部门/所有人时使用 |
权限说明:
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"rule_ids": [10001, 10002]
}
返回参数说明:
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| rule_ids | 创建成功后生成的规则 ID 列表,与请求 rules 顺序对应 |
