Skip to content

获取可见性规则列表

适用版本>=v7.0.2511.20251120

接口说明:分页获取企业下的所有可见性规则

标签通讯录可见性

请求说明

字段
请求地址
配置域名+/openapi+/v7/contacts/visibility/rules
HTTP 方法
GET
接口描述
分页获取企业下的所有可见性规则
签名方式
KSO-1(配置域名+/openapi不参与签名)
限频策略
权限要求
查询和管理通讯录信息(应用授权) kso.contact.readwrite
查询通讯录信息(应用授权) kso.contact.read

请求头 (Headers)

属性名类型是否必填描述可选值
X-Kso-Id-Type
string类型
* internal - 内部
* external - 外部
internal, external
X-Kso-Date
stringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT-
X-Kso-Authorization
stringKSO-1 签名值,详见《签名方法》-
Authorization
string授权凭证,格式为:Bearer {access_token}-

查询参数 (Query)

属性名类型是否必填描述可选值
offset
integer分页偏移量-
limit
integer分页大小-
with_total
boolean是否返回规则总数-

响应体(Response)

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例

json
{
  "data": {
    "rules": [
      {
        "ctime": 0,
        "id": "string",
        "mtime": 0,
        "include_local_dept": true,
        "subject_objs": [
          {
            "abs_path": "string",
            "id": "string",
            "name": "string",
            "type": "string"
          }
        ],
        "subject_objs_exclude_list": [
          {
            "abs_path": "string",
            "id": "string",
            "name": "string",
            "type": "string"
          }
        ],
        "visible_objs": [
          {
            "abs_path": "string",
            "id": "string",
            "name": "string",
            "type": "string"
          }
        ],
        "visible_type": "string"
      }
    ],
    "total": 0
  },
  "code": 0,
  "msg": "string"
}