文档中心 > API类目 > 钉钉API

dingtalk.oapi.inactive.user.v2.get (根据日期查询企业下未活跃用户或活跃用户列表数据)

根据日期查询企业下未活跃用户或活跃用户列表数据

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
is_active	Boolean	必须	false		是否活跃 false不活跃 true 活跃
dept_ids	Number []	可选	[1,2,3]	最大列表长度：100	过滤部门id列表，不传表示查询整个企业
offset	Number	必须	0		获取数据偏移量，第一页使用0，后面页使用接口返回的nextCursor
size	Number	必须	100		获取数据size,最大100
query_date	String	必须	20200101		查询日期, 日期格式yyyyMMdd

响应参数

名称	类型	示例值	描述
result	PageVo	{}	未活跃用户数据
└ next_cursor Number 1000 下一页的偏移量 └ list String [] [] 用户列表 └ has_more Boolean false 是否有更多数据
errmsg	String	ok	错误描述
errcode	Number	0	错误码

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/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());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/inactive/user/v2/get");
OapiInactiveUserV2GetRequest req = new OapiInactiveUserV2GetRequest();
req.IsActive = false;
req.DeptIds = "1,2,3";
req.Offset = 0L;
req.Size = 100L;
req.QueryDate = "20200101";
OapiInactiveUserV2GetResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

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("[1,2,3]");
$req->setOffset("0");
$req->setSize("100");
$req->setQueryDate("20200101");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/inactive/user/v2/get");

curl -X POST "https://oapi.dingtalk.com/topapi/inactive/user/v2/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=f5eeb0b5-a43b-47ce-a35d-8d28db9fbda6' \
-d 'dept_ids=1%2C2%2C3' \
-d 'is_active=false' \
-d 'offset=0' \
-d 'query_date=20200101' \
-d 'size=100'

# -*- coding: utf-8 -*-
import dingtalk.api

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

req.is_active=false
req.dept_ids="[1,2,3]"
req.offset=0
req.size=100
req.query_date="20200101"
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.inactive.user.v2.get");
add_param(pRequest,"is_active","false");
add_param(pRequest,"dept_ids","1,2,3");
add_param(pRequest,"offset","0");
add_param(pRequest,"size","100");
add_param(pRequest,"query_date","20200101");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.inactive.user.v2.get', {
	'is_active':'false',
	'dept_ids':'1,2,3',
	'offset':'0',
	'size':'100',
	'query_date':'20200101'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "next_cursor":1000,
        "list":{
            "string":[
                "[]"
            ]
        },
        "has_more":false
    },
    "errmsg":"ok",
    "errcode":0
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

用户反馈

亲，您还没填写反馈内容。

联系方式

亲，电话号码格式不正确。

验证码刷新
亲，验证码错啦！

提交反馈

用户反馈

感谢您的反馈！

用户反馈

网络异常，请重新提交！
重新提交

钉钉API

dingtalk.oapi.inactive.user.v2.get (根据日期查询企业下未活跃用户或活跃用户列表数据)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈