获取根部门
API 说明
获取当前企业的根部门信息。根部门是企业组织架构树的顶层节点,所有其他部门均为其直接或间接子部门。
注意事项:
- 仅支持应用身份(
app_access_token)调用,不支持用户身份。 - 该接口无请求参数,直接返回当前企业的根部门。
- 接口会校验根部门是否在应用的通讯录可见范围内,不可见时返回 403 错误。
- 响应中的
leaders字段会根据通讯录可见性规则进行过滤,可能不包含所有部门领导。
使用限制:
- 需要通讯录相关权限(
kso.contact.read或kso.contact.readwrite)才能调用该接口。
请求说明
| 字段 | 值 |
|---|---|
| 请求地址 | https://openapi.wps.cn/v7/depts/root |
| HTTP 方法 | GET |
| 签名方式 | KSO-1 |
| 限频策略 | 应用 10次/秒 |
| 权限要求 | 查询和管理通讯录信息(应用授权) kso.contact.readwrite查询通讯录信息(应用授权) kso.contact.read |
请求头(Headers)
| Header 名称 | 参数类型 | 是否必填 | 可选值 | 限制 | 示例 | 描述 |
|---|---|---|---|---|---|---|
| Content-Type | string | 否 | application/json | - | application/json | 请求内容类型(该接口为 GET 请求,可省略) |
| X-Kso-Date | string | 是 | - | 必须符合 RFC1123 规范 | Thu, 29 May 2026 07:00:00 GMT | RFC1123 格式的日期时间 |
| X-Kso-Authorization | string | 是 | - | - | KSO-1 AK…:… | KSO-1 签名值,详见 签名方法 |
| Authorization | string | 是 | - | 必须以 Bearer 开头 | Bearer {access_token} | 授权凭证,格式为:Bearer {access_token},获取方式详见 认证授权概述 |
请求示例
cURL
bash
curl -X GET "https://openapi.wps.cn/v7/depts/root" \
-H "Authorization: Bearer {access_token}" \
-H "X-Kso-Date: Thu, 29 May 2026 07:00:00 GMT" \
-H "X-Kso-Authorization: {kso1_signature}"
Go
go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://openapi.wps.cn/v7/depts/root", nil)
req.Header.Set("Authorization", "Bearer {access_token}")
req.Header.Set("X-Kso-Date", "Thu, 29 May 2026 07:00:00 GMT")
req.Header.Set("X-Kso-Authorization", "{kso1_signature}")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
respBody, _ := io.ReadAll(resp.Body)
fmt.Println(string(respBody))
}
响应体(Response)
| 参数名称 | 参数类型 | 可选值 | 限制 | 示例 | 描述 |
|---|---|---|---|---|---|
| code | integer | - | - | 0 | 响应代码。非 0 表示失败,参照《状态码说明》 |
| msg | string | - | 最大长度 128 | "success" | 响应信息 |
| data | object | - | - | 根部门信息 | |
| ∟ id | string | - | 字符长度[1,128] | "dept_root_001" | 部门 ID |
| ∟ name | string | - | 字符长度[1,128] | "金山办公" | 部门名称 |
| ∟ parent_id | string | - | 字符长度[1,128] | "0" | 父部门 ID(根部门的父部门 ID 为 "0") |
| ∟ order | integer | - | - | 0 | 排序值 |
| ∟ abs_path | string | - | 最大长度 1024 | "/金山办公" | 绝对路径 |
| ∟ ex_dept_id | string | - | 最大长度 128 | "" | 部门外部 ID,可以是外部身份源的 ID,为空则默认为部门 ID |
| ∟ leaders | array[object] | - | 最大 10 项 | 部门领导列表(经可见性过滤) | |
| ∟∟ user_id | string | - | 字符长度[1,128] | "uid_example_001" | 领导用户 ID |
| ∟∟ order | integer | - | - | 0 | 排序值 |
| ∟ ctime | integer | - | - | 1682000000 | 创建时间,Unix 时间戳(秒) |
响应示例
json
{
"code": 0,
"msg": "success",
"data": {
"id": "dept_root_001",
"name": "金山办公",
"parent_id": "0",
"order": 0,
"abs_path": "/金山办公",
"ex_dept_id": "",
"leaders": [
{
"user_id": "uid_example_001",
"order": 0
}
],
"ctime": 1682000000
}
}
错误码
| HTTP状态码 | 错误码 | 错误描述 | 排查建议 |
|---|---|---|---|
| 400 | 400002113 | 根部门不存在 | 企业可能尚未初始化组织架构,请联系管理员确认 |
| 401 | 401000001 | access_token 无效或已过期 | 检查 Authorization 头中的 token 是否正确,是否已过期,需重新获取 |
| 403 | 403000001 | 权限不足 | 确认应用已被授予 kso.contact.read 或 kso.contact.readwrite 权限;确认根部门在应用的通讯录可见范围内 |
| 429 | 429000001 | 请求频率超限 | 降低请求频率 |
| 500 | 500000004 | 服务内部错误 | 请稍后重试,若持续出现请联系技术支持 |
元信息
yaml
---
name: open_v7_get_root_dept
description: "获取根部门"
metadata:
business_domain: "通讯录"
updated-on: "2026-05-29"
tags: "dept"
operation-id: "open_v7_get_root_dept"
sign-type: "[KSO-1](https://365.kdocs.cn/3rd/open/documents/app-integration-dev/wps365/server/api-description/signature-description)"
auth-type: "app_access_token"
scopes: "kso.contact.read"
rate-limit: "应用 10次/秒"
---