Developer OpenAPI
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
服务端API
  • 历史文档(不推荐)
  • 开发钉钉应用
  • 服务端API
  • 新版服务端API(DingTalk OpenAPI)
  • 生态伙伴API
获取凭证(access_token)身份验证(免登)应用授权通讯录管理互联平台群会话管理消息通知智能工作流智能填表智能人事考勤日志签到公告钉钉运动应用管理文件存储钉盘新教育专属钉钉智能办公电话应用市场项目管理客户管理(官方CRM)培训智能硬件
获取凭证(access_token)身份验证(免登)应用授权通讯录管理互联平台群会话管理消息通知智能工作流智能填表智能人事考勤日志签到公告钉钉运动应用管理文件存储钉盘新教育专属钉钉智能办公电话应用市场项目管理客户管理(官方CRM)培训智能硬件
  1. 设备管理
  • 设备管理
    • 绑定设备
      POST
    • 解绑设备
      POST
    • 修改设备昵称
      POST
    • 查询设备列表
      POST
    • 查询设备详情
      POST
    • 根据设备ID查询设备
      POST
  1. 设备管理

查询设备详情

POST
http://127.0.0.1/topapi/smartdevice/device/query
服务端API/智能硬件/设备管理
最后修改时间:2022-08-30 09:19:23
责任人:未设置

说明#

调用本接口查询企业下的智能硬件设备详情。
服务地址:https://oapi.dingtalk.com

权限#

服务端API是以应用维度授权的,在调用接口前,确保已经为应用添加了接口权限。详情请参考权限申请。
应用类型是否支持调用权限申请方式API Explorer调试
企业内部应用是开发者后台申请调试
第三方企业应用是开发者后台申请调试
第三方个人应用否——

请求参数

Query 参数
access_token
string 
必需
调用服务端API的应用凭证。企业内部应用可通过获取企业内部应用的access_token接口获取。第三方企业应用可通过获取第三方企业应用的access_token接口获取。
示例值:
6d1bxxxx
Body 参数application/json
device_query_vo
object 
设备查询对象。
可选
pk
string 
产品的唯一标识。
必需
device_name
string 
可选
设备名称,可通过查询设备列表接口获取。该参数不能和设备id同时为空。
device_id
string 
可选
设备的id,可通过查询设备列表接口获取。该参数不能和设备名称同时为空。
示例
{
  "device_query_vo": {
    "device_name": "产品智能",
    "device_id": "QWR45GT",
    "pk": "pk_01"
  }
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://127.0.0.1/topapi/smartdevice/device/query?access_token=6d1bxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "device_query_vo": {
        "device_name": "产品智能",
        "device_id": "QWR45GT",
        "pk": "pk_01"
    }
}'

返回响应

🟢200成功
application/json
Body
result
object 
返回结果。
可选
device_mac
string 
设备的mac地址。
可选
corp_id
string 
企业id。
可选
nick
string 
设备的昵称。
可选
device_id
string 
设备的id。
可选
device_name
string 
设备名称。
可选
pk
string 
产品的唯一标识。
可选
userid
string 
可选
员工的userid。
ext
string 
备注信息。
可选
sn
string 
设备序列号。
可选
success
boolean 
请求是否成功。
可选
errcode
number 
返回码。
可选
errmsg
string 
返回码描述。
可选
request_id
string 
请求ID。
可选
示例
{
  "result": {
    "device_mac": "string",
    "corp_id": "string",
    "nick": "string",
    "device_id": "string",
    "device_name": "string",
    "pk": "string",
    "userid": "string",
    "ext": "string",
    "sn": "string"
  },
  "success": true,
  "errcode": 0,
  "errmsg": "string",
  "request_id": "string"
}
上一页
查询设备列表
下一页
根据设备ID查询设备
Built with