本文内容

获取子部门列表

用于获取指定部门下的子部门,该接口遵循通讯录权限范围数据控制。

入参部门ID为0,即检验应用是否有全员通讯录权限,如果是非0 部门ID,则会校验应用是否有该部门的通讯录权限。由于接口安全性能限制,当部门ID为0时,暂不支持递归获取其下多级子部门。如确有需要,请联系官方客服人员进行需求沟通。

请求说明

请求地址 https://openapi.wps.cn/plus/v1/company/depts/:dept_id/children
请求方法 GET
签名方式 wps-3
支持应用类型 企业自建应用、第三方企业应用
权限要求 访问企业通讯录(corp_contacts.read)

请求头

Header名称 是否必填 说明
Content-Type 目前固定为:"application/json"
Content-Md5 当HTTP请求的Body有数据时,计算Body的MD5值,否则计算空字符串的MD5值。再将MD5值转为十六进制字符串形式。即:Format("%x", md5Byte)
Date RFC1123格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Auth X-Auth计算方法参考签名说明

路径参数(Path)

名称 类型 是否必填 说明
dept_id string 部门 id,值为 0 的情况下返回根部门的信息

查询参数(Query)

名称 类型 是否必填 说明
company_token string 企业授权凭证
offset integer 下标,从 0 开始
limit integer 大小,不超过 1000
recursive boolean 是否递归获取,默认 false

请求地址示例

[GET] https://openapi.wps.cn/plus/v1/company/depts/1/children?company_token=COMPANY_TOKEN&offset=0&limit=100

响应体

名称 类型 说明
result integer 状态码,非 0 表示失败,参照《状态码说明》
depts array 部门列表
 ∟ dept_pid string 父部门 id
 ∟ dept_id string 部门 id
 ∟ name string 部门名
 ∟ ctime integer 部门创建时间,秒为单位的时间戳
 ∟ order integer 部门排序字段,值越大排序优先级越

响应体示例

{
    "depts":[
         {
            "dept_pid": "string",
            "dept_id": "string",
            "name": "string",
            "ctime": integer,
            "order": integer
         },
         ......
    ],
    "result": 0
}
本文内容