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

dingtalk.corp.device.manage.querylist (拉取企业下某类设备列表)

此接口用于展示企业已经绑定的设备列表(分页接口)

公共参数

请求地址：

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

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
device_service_id	Number	必须	14		设备服务商ID
cursor	Number	必须	0		分页拉取设备列表的游标，首次拉取可传Null或者0
size	Number	必须	20	最大值：20	单次请求的大小，最大不超过20

响应参数

名称	类型	示例值	描述
result	DingOpenResult		返回结果
result PageVo 返回的Page对象 list OpenDeviceVo [] 设备列表 └ nick String 考勤机A 设备昵称 └ device_id String ding1234 设备ID └ avatar String http://xxxxx 设备头像 └ device_type_name String 德力考勤机设备类型名称 └ on_line_status Number 1 设备在线状态{1:在线，0:不在线} └ device_sn String 0202APW170201N023571 设备SN └ device_mac String 设备MAC地址 └ next_cursor Number 10000 下次拉取列表的游标，如果为Null，代表没有数据了 └ error_msg String success 错误信息 └ ding_open_errcode Number 0 错误码 └ success Boolean true request是否成功

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpDeviceManageQuerylistRequest req = new CorpDeviceManageQuerylistRequest();
req.setDeviceServiceId(14L);
req.setCursor(0L);
req.setSize(20L);
CorpDeviceManageQuerylistResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpDeviceManageQuerylistRequest req = new CorpDeviceManageQuerylistRequest();
req.DeviceServiceId = 14L;
req.Cursor = 0L;
req.Size = 20L;
CorpDeviceManageQuerylistResponse 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_TOP, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new CorpDeviceManageQuerylistRequest;
$req->setDeviceServiceId("14");
$req->setCursor("0");
$req->setSize("20");
$resp = $c->execute($req, $access_token, "https://eco.taobao.com/router/rest");

curl -X POST "https://eco.taobao.com/router/rest" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'format=json' \
-d 'method=dingtalk.corp.device.manage.querylist' \
-d 'partner_id=apidoc' \
-d 'session=60d7fe82-07f4-4a6a-b08c-dee8204558d8' \
-d 'timestamp=2025-06-13+03%3A43%3A52' \
-d 'v=2.0' \
-d 'cursor=0' \
-d 'device_service_id=14' \
-d 'size=20'

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

req=dingtalk.api.CorpDeviceManageQuerylistRequest("https://eco.taobao.com/router/rest")

req.device_service_id=14
req.cursor=0
req.size=20
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.corp.device.manage.querylist");
add_param(pRequest,"device_service_id","14");
add_param(pRequest,"cursor","0");
add_param(pRequest,"size","20");
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.corp.device.manage.querylist', {
	'device_service_id':'14',
	'cursor':'0',
	'size':'20'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<dingtalk_corp_device_manage_querylist_response>
    <result>
        <result>
            <list>
                <open_device_vo>
                    <nick>考勤机A</nick>
                    <device_id>ding1234</device_id>
                    <avatar>http://xxxxx</avatar>
                    <device_type_name>德力考勤机</device_type_name>
                    <on_line_status>1</on_line_status>
                    <device_sn>0202APW170201N023571</device_sn>
                    <device_mac></device_mac>
                </open_device_vo>
            </list>
            <next_cursor>10000</next_cursor>
        </result>
        <error_msg>success</error_msg>
        <ding_open_errcode>0</ding_open_errcode>
        <success>true</success>
    </result>
</dingtalk_corp_device_manage_querylist_response>

{
    "dingtalk_corp_device_manage_querylist_response":{
        "result":{
            "result":{
                "list":{
                    "open_device_vo":[
                        {
                            "nick":"考勤机A",
                            "device_id":"ding1234",
                            "avatar":"http:\/\/xxxxx",
                            "device_type_name":"德力考勤机",
                            "on_line_status":1,
                            "device_sn":"0202APW170201N023571",
                            "device_mac":""
                        }
                    ]
                },
                "next_cursor":10000
            },
            "error_msg":"success",
            "ding_open_errcode":0,
            "success":true
        }
    }
}

异常示例

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

钉钉API

dingtalk.corp.device.manage.querylist (拉取企业下某类设备列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈