开发指南请求
| 基本信息 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/attendance/group/get |
| HTTP Method | POST |
| 支持的应用类型 | appType-企业内部应用 |
| 权限要求 | permission-qyapi_attendance_group_read-考勤组查询权限 |
查询参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| access_token | String | 是 | 4c9ebd2b1534xxxx | 调用该接口的应用凭证，通过获取企业内部应用的access_token接口获取。 |
请求体
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| op_userid | String | 否 | user123 | 操作人userId。 |
| group_key | String | 是 | 02B1Exxxx | 考勤组groupKey。 说明 如果你使用的考勤组标识是group_id，可以调用groupId转换为groupKey接口将group_id转换为group_key。 |
请求示例
curl -X POST "https://api.dingtalk.io/topapi/attendance/group/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=9d319xxxx6e5f0' \
-d 'group_key=0151E0xxxx2A1A917' \
-d 'op_userid=123456'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/group/get");
OapiAttendanceGroupGetRequest req = new OapiAttendanceGroupGetRequest();
req.setOpUserid("123456");
req.setGroupKey("0151E022xxxxx1A917");
OapiAttendanceGroupGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiAttendanceGroupGetRequest("https://api.dingtalk.io/topapi/attendance/group/get")
req.op_userid="123456"
req.group_key="0151E02xxxxA1A917"
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 OapiAttendanceGroupGetRequest;
$req->setOpUserid("123456");
$req->setGroupKey("0151Exxxx1A917");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/attendance/group/get");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/group/get");
OapiAttendanceGroupGetRequest req = new OapiAttendanceGroupGetRequest();
req.OpUserid = "123456";
req.GroupKey = "0151E0xxxxA1A917";
OapiAttendanceGroupGetResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
响应
响应体
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| result | Object | 考勤组信息结果。 | |
| name | String | 测试考勤组1 | 考勤组名称。 |
| ext | String | 扩展字段，JSON格式。 | |
| location_offset | Number | 100 | 打卡范围，单位为米。 说明 该字段已废弃，请以批量查询地点接口返回的offset为准。 |
| group_key | String | 0151E0223B1EDDDF00DD6B7F72A1A917 | 考勤组groupKey。 |
| enable_face_check | Boolean | false | 是否开启笑脸打卡。 - true：开启 - false（默认）：关闭 |
| enable_face_beauty | Boolean | false | 是否开启美颜。 - true：开启 - false（默认）：关闭 |
| enable_camera_check | Boolean | false | 是否开启拍照打卡。 - true：开启 - false（默认）：关闭 |
| enable_outside_check | Boolean | false | 是否允许外勤打卡。 - true：允许 - false（默认）：不允许 |
| enable_outside_apply | Boolean | false | 外勤打卡是否需要审批。 - true：需要 - false（默认）：不需要 |
| outside_check_approve_mode | Number | 0 | 外勤打卡审批模式。 - -1（默认）：关闭 - 0：先审批，再打卡 - 1：先打卡，再审批 |
| enable_outside_remark | Boolean | false | 外勤打卡是否需要填写备注。 - true：需要 - false（默认）：不需要 |
| enable_outside_camera_check | Boolean | false | 外勤打卡是否需要拍照备注。 - true：需要 - false（默认）：不需要 |
| forbid_hide_outside_address | Boolean | true | 是否禁止员工隐藏详细地址。 - true（默认）：禁止 - false：不禁止 |
| enable_outside_update_normal_check | Boolean | false | 是否允许外勤卡更新内勤卡。 - true：允许 - false（默认）：不允许 |
| enable_trim_distance | Boolean | false | 是否允许地点微调距离。 - true：允许 - false（默认）：不允许 |
| trim_distance | Number | 50 | 地点微调范围，单位为米。 |
| errmsg | String | ok | 返回的错误信息描述。 |
| success | Boolean | true | 是否成功。 - true：成功 - false：失败 |
| errcode | Number | 0 | 错误码。 |
响应体示例
{
"result":{
"ext":"",
"enable_camera_check":false,
"enable_face_beauty":false,
"outside_check_approve_mode":0,
"forbid_hide_outside_address":true,
"enable_face_check":false,
"enable_outside_apply":false,
"enable_outside_camera_check":false,
"enable_outside_update_normal_check":false,
"trim_distance":50,
"enable_outside_check":false,
"location_offset":100,
"enable_outside_remark":false,
"name":"测试考勤组1",
"group_key":"0151E0223B1EDDDF00DD6B7F72A1A917",
"enable_trim_distance":false
},
"errcode":0,
"success":true,
"errmsg":"ok"
}