跳转到主要内容
调用本接口，获取角色列表。

​
请求

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

​
查询参数

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

​
请求体

名称类型是否必填示例值描述
sizeNumber否20支持分页查询，与offset参数同时设置时才生效，此参数代表分页大小**，默认值20，**最大值200。
offsetNumber否0支持分页查询，与size参数同时设置时才生效，此参数代表偏移量，偏移量从0开始。

​
请求示例

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

req=dingtalk.api.OapiRoleListRequest("https://oapi.dingtalk.io/topapi/role/list")

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

​
响应

​
响应体

名称类型示例值描述
request_idStringii8a42qgzu7e请求ID。
errcodeNumber0返回码。
errmsgStringok返回码描述。
resultPageVo结果列表。
hasMoreBooleanfalse是否还有更多数据。
listOpenRoleGroup[]角色组列表。
nameString默认角色组名称。
groupIdNumber1507113577角色组ID。
rolesOpenRole[]角色列表。
nameString管理员角色名称。
idNumber1507113578角色ID。

​
响应体示例

{
  "errcode": 0,
  "result": {
    "hasMore": true,
    "list": [
      {
        "groupId": 1507113577,
        "name": "默认",
        "roles": [
          {
            "id": 1507113580,
            "name": "负责人"
          },
          {
            "id": 1507113581,
            "name": "主管"
          },
          {
            "id": 1507113578,
            "name": "主管理员"
          },
          {
            "id": 1507113579,
            "name": "子管理员"
          }
        ]
      }
    ]
  },
  "request_id": "ii8a42qgzu7e"
}

​
错误码

若调用该接口报错，可根据错误信息在全局错误码文档中查找解决方案。
错误码（errcode）错误码描述（errmsg）解决方案
400043非法的orgId请检查access_token是否正确
40069非法的size请调整分页的大小
40068无效的偏移量请调整偏移量的大小
400001系统错误请稍后再试