跳转到主要内容
调用本接口,获取指定角色的员工列表。

请求

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

查询参数

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

请求体

名称类型是否必填示例值描述
role_idNumber1203141角色roleId,可通过调用获取角色列表接口获取id参数值。
sizeNumber20分页大小。 说明 与offset参数同时设置时才生效,此参数代表分页大小,默认值20,最大100。
offsetNumber0分页偏移量。 说明 与size参数同时设置时才生效,此参数代表偏移量,偏移量从0开始。

请求示例

curl -X POST "https://oapi.dingtalk.io/topapi/role/simplelist" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=d1812xxxxc53245' \
-d 'offset=0' \
-d 'role_id=1203141' \
-d 'size=20'
Java
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/role/simplelist");
OapiRoleSimplelistRequest req = new OapiRoleSimplelistRequest();
req.setRoleId(1203141L);
req.setSize(20L);
req.setOffset(0L);
OapiRoleSimplelistResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
Python
import dingtalk.api

req=dingtalk.api.OapiRoleSimplelistRequest("https://oapi.dingtalk.io/topapi/role/simplelist")

req.role_id=1203141
req.offset=0
req.size=20
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 OapiRoleSimplelistRequest;
$req->setRoleId("1203141");
$req->setOffset("0");
$req->setSize("20");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.io/topapi/role/simplelist");
C#
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/role/simplelist");
OapiRoleSimplelistRequest req = new OapiRoleSimplelistRequest();
req.RoleId = 1203141L;
req.Offset = 0L;
req.Size = 20L;
OapiRoleSimplelistResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

响应

响应体

名称类型示例值描述
request_idStringf6249uw1kuus请求ID。
errcodeNumber0返回码。
errmsgStringok返回码描述。
resultPageVo查询结果。
hasMoreBooleantrue是否还有更多数据。
listOpenEmpSimple[]角色下的员工列表。
useridStringmanager4220员工的userid。
nameString小钉员工姓名。
manageScopesOrgDeptVo[]管理范围。
dept_idNumber11部门ID。
nameString纪检部部门名称。

响应体示例

{
  "errcode": 0,
  "result": {
    "hasMore": false,
    "list": [
      {
        "name": "小钉",
        "userid": "manager4220",
        "manageScopes":[
          {
            "dept_id":11,
            "name":"纪检部"
          }
        ]
      }
    ]
  },
  "request_id": "f6249uw1kuus"
}

错误码

若调用该接口报错,可根据错误信息在全局错误码文档中查找解决方案。
错误码(errorcode)错误码描述(errmsg)解决方案
33011无效的roleId请检查roleId是否正确
40069无效的size请调整分页大小
40068无效的偏移量请调整偏移量
400001系统错误请稍后重试