根据设备ID查询设备
调用本接口根据设备ID查询企业下某个智能硬件设备。
调用本接口前请完成对接,请填写表单并详细描述智能硬件接口的应用场景,以确保正常调用。
权限
服务端API是以应用维度授权的,在调用接口前,确保已经为应用添加了接口权限。
应用类型 | 是否支持调用 | 权限 | API Explorer调试 |
企业内部应用 | 是 | 智能设备管理的基本权限 | |
第三方企业应用 | 是 | 智能设备管理的基本权限 | |
第三方个人应用 | 否 | 暂不支持 | 暂不支持 |
基本信息
请求方式:POST
请求地址:https://oapi.dingtalk.com/topapi/smartdevice/device/querybyid
Query参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
access_token | String | 是 | 6d1bxxxx | 调用服务端API的应用凭证。
|
Body参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
device_query_vo | DeviceQueryVo | 是 | 设备查询对象。 | |
device_id | String | 是 | QWR45GT | 设备id: |
返回参数
名称 | 类型 | 示例值 | 描述 |
result | DeviceDetailVO | result | 返回结果。 |
device_mac | String | 11:11:11:11:11 | 设备的mac地址。 |
corp_id | String | ding9f5xxxx | 企业的corpid。 |
nick | String | ding | 设备的昵称。 |
device_id | String | QWR45GT | 设备的id。 |
device_name | String | 产品智能 | 设备名称。 |
pk | String | pk_01 | 产品的唯一标识。 |
userid | String | user01 | 员工的userid。 |
ext | String | 智能产品 | 备注信息。 |
sn | String | sdx123d123asdf | 设备序列号。 |
success | Boolean | true | 请求是否成功。 |
errcode | Number | 0 | 返回码。 |
errmsg | String | ok | 返回码描述。 |
request_id | String | exz1t52e9awo | 请求ID。 |
示例
请求示例(HTTP)
POST https://oapi.dingtalk.com/topapi/smartdevice/device/querybyid?access_token=ACCESS_TOKEN请求正文
{
"device_query_vo":{
"device_id":"QWR45GT"
}
}请求示例(JAVA SDK)
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/smartdevice/device/querybyid");
OapiSmartdeviceDeviceQuerybyidRequest req = new OapiSmartdeviceDeviceQuerybyidRequest();
DeviceQueryVo deviceQueryVo = new DeviceQueryVo();
deviceQueryVo.setDeviceId("QWR45GT");
req.setDeviceQueryVo(deviceQueryVo);
OapiSmartdeviceDeviceQuerybyidResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());返回示例
{
"result":{
"nick":"ding",
"ext":"智能产品",
"device_mac":"11:11:11:11:11",
"device_name":"产品智能",
"device_id":"QWR45GT",
"pk":"pk_01",
"sn":"sdx123d123asdf",
"corp_id":"ding9f5xxxx",
"userid":"user01"
},
"errcode":0,
"success":true,
"request_id": "exz1t52e9awo"
}