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

dingtalk.oapi.smartdevice.device.querybyid (智能硬件根据设备id查询详情)

查询企业下的智能硬件设备详情

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
device_query_vo	DeviceQueryVo	必须			设备查询对象
└ device_id String 必须 yourdeviceid 设备id

响应参数

名称	类型	示例值	描述
result	DeviceDetailVO	result	返回结果
└ device_mac String xx:xx:xx:xx:xx:xx 设备mac └ corp_id String yourcopid 企业id └ nick String yourdevicenick 设备nick └ device_id String yourdeviceid 设备id └ device_name String yourdevicename 设备名称 └ pk String yourproductkey 产品标识 └ userid String abccd 员工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/querybyid");
OapiSmartdeviceDeviceQuerybyidRequest req = new OapiSmartdeviceDeviceQuerybyidRequest();
DeviceQueryVo obj1 = new DeviceQueryVo();
obj1.setDeviceId("yourdeviceid");
req.setDeviceQueryVo(obj1);
OapiSmartdeviceDeviceQuerybyidResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/smartdevice/device/querybyid");
OapiSmartdeviceDeviceQuerybyidRequest req = new OapiSmartdeviceDeviceQuerybyidRequest();
OapiSmartdeviceDeviceQuerybyidRequest.DeviceQueryVoDomain obj1 = new OapiSmartdeviceDeviceQuerybyidRequest.DeviceQueryVoDomain();
obj1.DeviceId = "yourdeviceid";
req.DeviceQueryVo_ = obj1;
OapiSmartdeviceDeviceQuerybyidResponse 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 OapiSmartdeviceDeviceQuerybyidRequest;
$device_query_vo = new DeviceQueryVo;
$device_query_vo->device_id="yourdeviceid";
$req->setDeviceQueryVo($device_query_vo);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/smartdevice/device/querybyid");

curl -X POST "https://oapi.dingtalk.com/topapi/smartdevice/device/querybyid" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=f6b59067-43c3-47cd-a6f8-ad43d7f0df6d' \
-d 'device_query_vo=null'

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

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

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

响应示例

JSON示例

{
    "result":{
        "device_mac":"xx:xx:xx:xx:xx:xx",
        "corp_id":"yourcopid",
        "nick":"yourdevicenick",
        "device_id":"yourdeviceid",
        "device_name":"yourdevicename",
        "pk":"yourproductkey",
        "userid":"abccd",
        "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.querybyid (智能硬件根据设备id查询详情)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ