跳转到主要内容

​
获取子部门ID列表

​
接口调用说明

  • 本接口不受授权范围限制。
  • 本接口只支持获取下一级所有部门ID列表。
例如，调用本接口获取根部门的子部门ID列表，获取的结果是[123,666]，部门1和部门2下的子部门是获取不到的。 子部门ID列表

​
请求

基本信息
HTTP URLhttps://oapi.dingtalk.io/topapi/v2/department/listsubid
HTTP MethodPOST
支持的应用类型appType-企业内部应用appType-第三方企业应用
权限要求permission-qyapi_get_department_list-通讯录部门信息读权限

​
查询参数

名称类型是否必填示例值描述
access_tokenString是bE74xxxx调用该API的应用凭证。 - 企业内部应用，通过获取企业内部应用的access_token接口获取。 - 第三方企业应用，通过获取第三方企业的access_token接口获取。

​
请求体

名称类型是否必填示例值描述
dept_idNumber是1父部门ID，根部门传1，可调用获取部门列表接口获取dept_id参数值。

​
请求示例

curl -X POST "https://oapi.dingtalk.io/topapi/v2/department/listsubid" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=0dcxxxx108dcd028' \
-d 'dept_id=100'
Java 
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/v2/department/listsubid");
OapiV2DepartmentListsubidRequest req = new OapiV2DepartmentListsubidRequest();
req.setDeptId(100L);
OapiV2DepartmentListsubidResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
Python 
import dingtalk.api

req=dingtalk.api.OapiV2DepartmentListsubidRequest("https://oapi.dingtalk.io/topapi/v2/department/listsubid")

req.dept_id=100
try:
  resp= req.getResponse(access_token)
  print(resp)
except Exception,e:
  print(e)
PHP 
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiV2DepartmentListsubidRequest;
$req->setDeptId("100");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.io/topapi/v2/department/listsubid");
C# 
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/v2/department/listsubid");
OapiV2DepartmentListsubidRequest req = new OapiV2DepartmentListsubidRequest();
req.DeptId = 100L;
OapiV2DepartmentListsubidResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

​
响应

​
响应体

名称类型示例值描述
request_idString48vhxdnwhve6请求ID。
errcodeNumber0返回码。
errmsgString不合法的部门id调用错误时返回的错误信息。
resultDeptListSubIdResponse返回结果。
dept_id_listNumber[][2,3,4,5]子部门列表。

​
响应体示例

{
  "errcode": 0,
  "errmsg":"ok",
  "result": {
    "dept_id_list": [
      379xxxx95,
      411xxxx76,
      399xxxx96,
      400xxxx83,
      404xxxx47
    ]
  },
  "request_id": "169dfniaazqb4"
}

​
错误码

若调用该接口报错，可根据错误信息在全局错误码文档中查找解决方案。
错误码（errcode）错误码描述（errmsg）解决方案
60003未找到对应部门请确认dept_id是否正确
400002无效的参数请确认参数是否按要求输入
-1系统繁忙请稍后重试