dingtalk.oapi.role.simplelist (获取角色的员工列表)

获取企业中角色下的员工列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
role_id Number 必须 1203141 角色ID
offset Number 可选 0
  • 默认值:0
  • 最小值:0
  • 支持分页查询,与size参数同时设置时才生效,此参数代表偏移量,偏移量从0开始。
    size Number 可选 20
  • 默认值:20
  • 最小值:1
  • 支持分页查询,与offset参数同时设置时才生效,此参数代表分页大小,最大100。

    响应参数

    名称 类型 示例值 描述
    errcode Number errcode
    errmsg String errmsg
    result PageVo {"hasMore": false, list: [{"userId":"123", "name":"h"}]} result
    • └ hasMore
    • Boolean
    • true
    • 后面是否还有数据
    • └ nextCursor
    • Number
    • 100
    • 下次拉取数据的游标
    • list
    • OpenEmpSimple []
    • list
    • └ userid
    • String
    • manager7978
    • 员工id
    • └ name
    • String
    • 小钉
    • 员工姓名
    • manageScopes
    • OrgDeptVo []
    • 管理范围
    • └ dept_id
    • Number
    • 11
    • 部门id
    • └ name
    • String
    • test
    • 部门名称

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/role/simplelist");
    OapiRoleSimplelistRequest req = new OapiRoleSimplelistRequest();
    req.setRoleId(1203141L);
    req.setOffset(0L);
    req.setSize(20L);
    OapiRoleSimplelistResponse rsp = client.execute(req, access_token);
    System.out.println(rsp.getBody());

    响应示例

    • JSON示例
    {
        "errcode":,
        "errmsg":"",
        "result":{
            "hasMore":true,
            "nextCursor":100,
            "list":[
                {
                        "userid":"manager7978",
                        "name":"小钉",
                        "manageScopes":[
                            {
                                    "dept_id":11,
                                    "name":"test"
                            }
                        ]
                }
            ]
        }
    }

    异常示例

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

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部