企业内部开发
基础
连接微信
办公
会议
会议统计管理
企业内部开发
服务端API
通讯录管理
通讯录查看权限管理
创建规则
创建规则
最后更新:2026/06/22

创建规则

该接口用于批量创建通讯录隐藏规则。规则范围使用 useridpartyidtagid 表达,可用于隐藏部门/成员、限制查看外部门、限制查看所有人等场景。

请求方式: 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 顺序对应
上一篇获取标签列表
下一篇读取规则列表
    本节内容
服务端API
基础
连接微信
办公
会议
会议统计管理
客户端API
小程序
基础
连接微信
办公
JS-SDK
基础
连接微信
办公
消息推送(原“群机器人”)
更新日志
联系我们