跳转到主要内容

​
获取部门用户userid列表

​
接口调用说明

  • 本接口不受通讯录权限范围限制。
  • 目前暂不支持一次性获取企业下所有员工userid值，如果开发者希望获取企业下所有员工userid值，可以通过以下方法：
    • 调用获取部门列表接口，通过逐级遍历，获取该企业下在授权范围内的所有部门ID。
    • 调用本文档接口，分别获取每一个部门下的员工userid。

​
请求

基本信息
HTTP URLhttps://oapi.dingtalk.io/topapi/user/listid
HTTP MethodPOST
支持的应用类型appType-企业内部应用appType-第三方企业应用
权限要求permission-qyapi_get_member-成员信息读权限

​
查询参数

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

​
请求体

名称类型是否必填示例值描述
dept_idNumber是100部门deptId，可通过调用获取部门列表获取部门deptId。 说明 如果是根部门，该参数传1。

​
请求示例

curl -X POST "https://oapi.dingtalk.io/topapi/user/listid" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=03987655-598f-4f7a-8fc3-aaf257c47c27' \
-d 'dept_id=100'
Java 
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/user/listid");
OapiUserListidRequest req = new OapiUserListidRequest();
req.setDeptId(100L);
OapiUserListidResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
Python 
import dingtalk.api

req=dingtalk.api.OapiUserListidRequest("https://oapi.dingtalk.io/topapi/user/listid")

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 OapiUserListidRequest;
$req->setDeptId("100");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.io/topapi/user/listid");
C# 
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/user/listid");
OapiUserListidRequest req = new OapiUserListidRequest();
req.DeptId = 100L;
OapiUserListidResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

​
响应

​
响应体

名称类型示例值描述
request_idString4f9kasjdhop请求ID。
errcodeNumber0返回码。
errmsgStringok返回码描述。
resultListUserByDeptResponse返回结果。
userid_listString[][“zxxxx”,“lixxxi”]指定部门的userid列表。

​
响应体示例

{
  "errcode": 0,
  "errmsg":"ok",
  "result": {
    "userid_list": [
      "usxxx",
      "manager4xxx",
      "10203029011xxxx",
      "usexxx"
    ]
  },
  "request_id": "3naksldjh0dk"
}

​
错误码

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