开发指南请求
| 基本信息 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/attendance/group/users/query |
| HTTP Method | POST |
| 支持的应用类型 | appType-企业内部应用 |
| 权限要求 | permission-qyapi_attendance_group_read-考勤组查询权限 |
查询参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| access_token | String | 是 | 4c9ebd2b1534xxxx | 调用该接口的应用凭证，通过获取企业内部应用的access_token接口获取。 |
请求体
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| size | Number | 否 | 50 | 分页大小。 |
| cursor | String | 是 | 10 | 上一批次最后一个userid，传null、空值表示从头开始查。 |
| op_userid | String | 否 | user01 | 操作人userId。 |
| group_key | String | 是 | CEDDFFxxxx | 考勤组ID。 说明 如果你使用的考勤组标识是group_id，可以调用groupId转换为groupKey接口将group_id转换为group_key。 |
请求示例
curl -X POST "https://api.dingtalk.io/topapi/attendance/group/users/query" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=d2ee6exxxx9266c' \
-d 'cursor=%5C%22%5C%22' \
-d 'group_key=0151Exxxx17E876' \
-d 'op_userid=123456' \
-d 'size=50'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/group/users/query");
OapiAttendanceGroupUsersQueryRequest req = new OapiAttendanceGroupUsersQueryRequest();
req.setSize(50L);
req.setCursor("10");
req.setOpUserid("user01");
req.setGroupKey("CEDDFFxxxx");
OapiAttendanceGroupUsersQueryResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiAttendanceGroupUsersQueryRequest("https://api.dingtalk.io/topapi/attendance/group/users/query")
req.size=50
req.cursor="\"\""
req.op_userid="123456"
req.group_key="0151E0xxxx17E876"
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 OapiAttendanceGroupUsersQueryRequest;
$req->setSize("50");
$req->setCursor("\"\"");
$req->setOpUserid("123456");
$req->setGroupKey("0151E02xxxx7E876");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/attendance/group/users/query");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/group/users/query");
OapiAttendanceGroupUsersQueryRequest req = new OapiAttendanceGroupUsersQueryRequest();
req.Size = 50L;
req.Cursor = "\"\"";
req.OpUserid = "123456";
req.GroupKey = "0151E0xxxxE876";
OapiAttendanceGroupUsersQueryResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
响应
响应体
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| request_id | String | ntxswpdprw5d | 请求ID。 |
| result | DingOpenResult | 返回结果。 | |
| result | Result | 查询结果。 | |
| user_list | String[] | user01 | 用户列表。 |
| has_more | String | false | 是否还有更多。 - true：有 - false：没有 |
| errcode | Number | 0 | 返回码。 |
| errmsg | String | ok | 返回码描述。 |
| success | Boolean | true | 是否成功。 - true：成功 - false：失败 |
响应体示例
{
"result": {
"errcode": 0,
"errmsg":"ok",
"result": {
"has_more": "false",
"user_list": [
"user01"
]
},
"success": true
},
"request_id": "ntxswpdprw5d"
}