跳转到主要内容
调用本接口查询指定日期内未登录钉钉的企业员工列表。

​
接口调用说明

  • 每天9点后调用接口才能确保获取前一天数据。
  • 调用本接口只能获取一个月内未登录钉钉的员工列表。

​
请求

基本信息
HTTP URLhttps://oapi.dingtalk.io/topapi/inactive/user/v2/get
HTTP MethodPOST
支持的应用类型appType-企业内部应用
权限要求permission-qyapi_liveness_base-企业活跃度数据访问权限

​
查询参数

名称类型是否必填示例值描述
access_tokenString是6d1bxxxx调用该接口的应用凭证，通过获取企业内部应用的access_token接口获取。

​
请求体

名称类型是否必填示例值描述
is_activeBoolean是false是否活跃： - false：未登录 - true：登录
dept_idsString否1,2,3部门ID列表，可调用获取部门列表获取，不传表示查询整个企业。
offsetNumber是1支持分页查询，与size参数同时设置时才生效，此参数代表偏移量，偏移量从0开始。
sizeNumber是100支持分页查询，与offset参数同时设置时才生效，此参数代表分页大小，最大100。
query_dateString是20200101查询日期，日期格式为：yyyyMMdd。

​
请求示例

curl -X POST "https://oapi.dingtalk.io/topapi/inactive/user/v2/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=2146ca78-23af-4580-9335-883348ff9a54' \
-d 'dept_ids=%5C%222%2C3%2C4%5C%22' \
-d 'is_active=false' \
-d 'offset=0' \
-d 'query_date=20200101' \
-d 'size=100'
Java 
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/inactive/user/v2/get");
OapiInactiveUserV2GetRequest req = new OapiInactiveUserV2GetRequest();
req.setIsActive(false);
req.setDeptIds("1,2,3");
req.setOffset(0L);
req.setSize(100L);
req.setQueryDate("20200101");
OapiInactiveUserV2GetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
Python 
import dingtalk.api

req=dingtalk.api.OapiInactiveUserV2GetRequest("https://oapi.dingtalk.io/topapi/inactive/user/v2/get")

req.is_active=false
req.dept_ids=""2,3,4""
req.offset=0
req.size=100
req.query_date="20200101"
try:
  resp= req.getResponse(access_token)
  print(resp)
except Exception,e:
  print(e)
PHP 
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiInactiveUserV2GetRequest;
$req->setIsActive("false");
$req->setDeptIds("\"2,3,4\"");
$req->setOffset("0");
$req->setSize("100");
$req->setQueryDate("20200101");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.io/topapi/inactive/user/v2/get");
C# 
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/inactive/user/v2/get");
OapiInactiveUserV2GetRequest req = new OapiInactiveUserV2GetRequest();
req.IsActive = false;
req.DeptIds = "\"2,3,4\"";
req.Offset = 0L;
req.Size = 100L;
req.QueryDate = "20200101";
OapiInactiveUserV2GetResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

​
响应

​
响应体

名称类型示例值描述
resultPageVo返回结果。
next_cursorNumber1000下一页的偏移量。
listString[][“user123”,“user456”]未登录用户列表。
has_moreBooleanfalse是否有更多数据。
errmsgStringok返回码描述。
errcodeNumber0返回码。
request_idStringo565d47xy9cz请求ID。

​
响应体示例

{
  "errcode": 0,
  "result": {
    "has_more": false,
    "list": [
      "011250026469774889",
      "0260470242730556"
    ]
  },
  "request_id": "o565d47xy9cz"
}

​
错误码

若调用该接口报错，可根据错误信息在全局错误码文档中查找解决方案。
错误码（errcode）错误码描述（errmsg）解决方案
400002参数非法请检查必填参数是否符合要求
40069无效的size请检查分页大小
40068无效的偏移量请调整偏移量
400002参数格式不正确请检查入参格式
-1系统繁忙请稍后再试