dingtalk.oapi.v2.department.listsub (获取部门列表)

获取部门列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
dept_id Number 可选 100
  • 默认值:1
  • 父部门id(如果不传,默认部门为根部门,根部门ID为1),只支持查询下一级子部门,不支持查询多级子部门
    language String 可选 zh_CN
  • 默认值:zh_CN
  • 通讯录语言(默认zh_CN,未来会支持en_US)

    响应参数

    名称 类型 示例值 描述
    errcode Number 0 返回码
    errmsg String ok 错误信息
    result DeptBaseResponse [] [] 部门列表
    • └ dept_id
    • Number
    • 100
    • 部门ID
    • └ name
    • String
    • HR
    • 部门名称
    • └ parent_id
    • Number
    • 50
    • 父部门ID
    • └ source_identifier
    • String
    • HR
    • 部门标识字段
    • └ create_dept_group
    • Boolean
    • true
    • 是否同步创建一个关联此部门的企业群
    • └ auto_add_user
    • Boolean
    • false
    • 当群已经创建后,是否有新人加入部门会自动加入该群
    • └ tags
    • String
    • campus
    • 教育行业部门类型
    • └ from_union_org
    • Boolean
    • false
    • 部门是否来自关联组织
    • └ ext
    • String
    • {}
    • 扩展字段

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/v2/department/listsub");
    OapiV2DepartmentListsubRequest req = new OapiV2DepartmentListsubRequest();
    req.setDeptId(100L);
    req.setLanguage("zh_CN");
    OapiV2DepartmentListsubResponse rsp = client.execute(req, access_token);
    System.out.println(rsp.getBody());

    响应示例

    • JSON示例
    {
        "errcode":0,
        "errmsg":"ok",
        "result":[
            {
                    "dept_id":100,
                    "name":"HR",
                    "parent_id":50,
                    "source_identifier":"HR",
                    "create_dept_group":true,
                    "auto_add_user":false,
                    "tags":"campus",
                    "from_union_org":false,
                    "ext":"{}"
            }
        ]
    }

    异常示例

    • JSON示例
    {
    	"errcode":88,
    	"errmsg":"ding talk error"
    }

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部