接口调用说明
参与考勤人员如果设置了部门,接口可以获取到部门ID,无法获取到部门下的人员列表。 例如,参与考勤人员设置了测试部门、员工张三,如下图所示。调用本接口可以获取到如下信息:- 测试部门ID,但无法获取到该部门下的员工userId列表
- 张三的userId
请求
| 基本信息 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/attendance/group/member/list |
| HTTP Method | POST |
| 支持的应用类型 | appType-企业内部应用 appType-第三方企业应用 |
| 权限要求 | permission-qyapi_attendance_group_read-考勤组查询权限 |
查询参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| access_token | String | 是 | bE74xxxx | 调用该API的应用凭证。 - 企业内部应用,通过获取企业内部应用的access_token接口获取。 - 第三方企业应用,通过获取第三方企业的access_token接口获取。 |
请求体
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| cursor | Number | 否 | 0 | 游标值,首次传入需要传0。默认值为0。 |
| op_user_id | String | 是 | user123 | 操作人userId。 |
| group_id | Number | 是 | 98562 | 考勤组ID。 说明 如果你使用的是旧考勤组标识即group_key,可以调用groupKey转换为groupId接口将group_key转换为group_id。 |
请求示例
curl -X POST "https://api.dingtalk.io/topapi/attendance/group/member/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=51525xxxx4e1df6' \
-d 'cursor=9828' \
-d 'group_id=98562' \
-d 'op_user_id=dd_dd'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/group/member/list");
OapiAttendanceGroupMemberListRequest req = new OapiAttendanceGroupMemberListRequest();
req.setCursor(0L);
req.setOpUserId("user123");
req.setGroupId(98562L);
OapiAttendanceGroupMemberListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiAttendanceGroupMemberListRequest("https://api.dingtalk.io/topapi/attendance/group/member/list")
req.cursor=9828
req.op_user_id="dd_dd"
req.group_id=98562
try:
resp= req.getResponse(access_token)
print(resp)
except Exception,e:
print(e)
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');
$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiAttendanceGroupMemberListRequest;
$req->setCursor("9828");
$req->setOpUserId("dd_dd");
$req->setGroupId("98562");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/attendance/group/member/list");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/group/member/list");
OapiAttendanceGroupMemberListRequest req = new OapiAttendanceGroupMemberListRequest();
req.Cursor = 9828L;
req.OpUserId = "dd_dd";
req.GroupId = 98562L;
OapiAttendanceGroupMemberListResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
响应
响应体
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| request_id | String | zpdxhqyepfon | 请求ID。 |
| errcode | Number | 0 | 返回码。 |
| success | Boolean | true | 是否成功标记。 - true:成功 - false:失败 |
| result | PageResult | 查询列表。 | |
| has_more | Boolean | false | 是否还有更多数据。 - true:有 - false:没有 |
| cursor | Number | 752095318 | 游标。 |
| result | TopGroupMemberVo[] | 人员userId列表。 | |
| atc_flag | String | 0 | 是否需要考勤。 - 0:需要考勤 - 1:无需考勤人员 |
| type | String | 0 | 类型。 - 0:员工 - 1:部门 |
| member_id | String | user123 | 成员Id,可以是userId或deptId。 |
响应体示例
{
"errcode": 0,
"result": {
"cursor": 794905780,
"has_more": false,
"result": [
{
"atc_flag": "0",
"member_id": "10203029011219896",
"type": "0"
}
]
},
"success": true,
"request_id": "4hwa7nhm07cs"
}