Developer GuideRequest
| Basic Information | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/attendance/group/users/query |
| HTTP Method | POST |
| Supported app types | appType-Internal app |
| Required permissions | permission-qyapi_attendance_group_read-Attendance group query permission |
Query Parameters
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| access_token | String | Yes | 4c9ebd2b1534xxxx | The App credential used to call this API. Obtain it by calling the Get the access_token of an Internal App API. |
Request Body
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| size | Number | No | 50 | The page size. |
| cursor | String | Yes | 10 | The last user ID of the previous batch. Pass null or an empty value to start the query from the beginning. |
| op_userid | String | No | user01 | The user ID of the operator. |
| group_key | String | Yes | CEDDFFxxxx | The attendance group ID. Note If your attendance group identifier is group_id, call the Convert groupId to groupKey API to convert group_id to group_key. |
Request Example
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);
Response
Response Body
| Name | Type | Example | Description |
|---|---|---|---|
| request_id | String | ntxswpdprw5d | The request ID. |
| result | DingOpenResult | The returned result. | |
| result | Result | The query result. | |
| user_list | String[] | user01 | The list of users. |
| has_more | String | false | Indicates whether more data is available. - true: Yes - false: No |
| errcode | Number | 0 | The return code. |
| errmsg | String | ok | The description of the return code. |
| success | Boolean | true | Indicates whether the call succeeded. - true: Success - false: Failed |
Response Body Example
{
"result": {
"errcode": 0,
"errmsg":"ok",
"result": {
"has_more": "false",
"user_list": [
"user01"
]
},
"success": true
},
"request_id": "ntxswpdprw5d"
}