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

dingtalk.oapi.smartdevice.device.querylist (智能硬件列表查询)

查询企业下的智能硬件设备列表

公共参数

环境	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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
page_query_vo	PageQueryVo	必须			列表查询对象
└ pk String 必须 yourproductkey 产品唯一编码 └ cursor Number 必须 0 游标地址,第一页填0 └ size Number 必须 20 分页大小，最大20

响应参数

名称	类型	示例值	描述
result	PageResult	result	返回结果
└ next_cursor Number 下一页的游标 └ has_more Boolean 是否有下一页 list DeviceDetailVO [] 设备类别 └ corp_id String yourcopid 企业id └ device_mac String xx:xx:xx:xx:xx:xx 设备mac └ nick String yourdevicenick 设备nick └ device_id String yourdeviceid 设备id └ device_name String yourdevicename 设备名称 └ pk String yourproductkey 产品标识 └ userid String abcde 绑定的员工id └ ext String yourdeviceext 备注信息 └ sn String yourdevicesn 设备序列号
success	Boolean	false	是否成功
errcode	Number	40001	错误代码
errmsg	String	系统繁忙	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/smartdevice/device/querylist");
OapiSmartdeviceDeviceQuerylistRequest req = new OapiSmartdeviceDeviceQuerylistRequest();
PageQueryVo obj1 = new PageQueryVo();
obj1.setPk("yourproductkey");
obj1.setCursor(0L);
obj1.setSize(20L);
req.setPageQueryVo(obj1);
OapiSmartdeviceDeviceQuerylistResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/smartdevice/device/querylist");
OapiSmartdeviceDeviceQuerylistRequest req = new OapiSmartdeviceDeviceQuerylistRequest();
OapiSmartdeviceDeviceQuerylistRequest.PageQueryVoDomain obj1 = new OapiSmartdeviceDeviceQuerylistRequest.PageQueryVoDomain();
obj1.Pk = "yourproductkey";
obj1.Cursor = 0L;
obj1.Size = 20L;
req.PageQueryVo_ = obj1;
OapiSmartdeviceDeviceQuerylistResponse 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 OapiSmartdeviceDeviceQuerylistRequest;
$page_query_vo = new PageQueryVo;
$page_query_vo->pk="yourproductkey";
$page_query_vo->cursor="0";
$page_query_vo->size="20";
$req->setPageQueryVo($page_query_vo);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/smartdevice/device/querylist");

curl -X POST "https://oapi.dingtalk.com/topapi/smartdevice/device/querylist" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=9b728fa2-51bf-47fd-b1ab-21516a0da4df' \
-d 'page_query_vo=null'

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

req=dingtalk.api.OapiSmartdeviceDeviceQuerylistRequest("https://oapi.dingtalk.com/topapi/smartdevice/device/querylist")

req.page_query_vo=""
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.smartdevice.device.querylist");
add_param(pRequest,"page_query_vo","数据结构JSON示例");
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.smartdevice.device.querylist', {
	'page_query_vo':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "next_cursor":,
        "has_more":,
        "list":[
            {
                    "corp_id":"yourcopid",
                    "device_mac":"xx:xx:xx:xx:xx:xx",
                    "nick":"yourdevicenick",
                    "device_id":"yourdeviceid",
                    "device_name":"yourdevicename",
                    "pk":"yourproductkey",
                    "userid":"abcde",
                    "ext":"yourdeviceext",
                    "sn":"yourdevicesn"
            }
        ]
    },
    "success":false,
    "errcode":40001,
    "errmsg":"系统繁忙"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.smartdevice.device.querylist (智能硬件列表查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ