docs: add OneNET API reference documentation

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-06-03 11:11:09 +08:00
parent 69e13f504f
commit 0845c38b72
10 changed files with 840 additions and 0 deletions
@@ -0,0 +1,128 @@
+设备详情
+最近更新时间：2026-03-30 09:58:43
+接口说明
+查询平台上已注册设备的详细信息
+
+接口地址
+https://iot-api.heclouds.com/device/detail
+
+API 说明
+请求方式：GET
+
+httpquery 请求参数
+
+参数名称	格式	是否必选	说明
+product_id	string	产品 id+设备名称、imei 二选一必填	产品 ID
+device_name	string	产品 id+设备名称、imei 二选一必填	设备名称
+imei	string	产品 id+设备名称、imei 二选一必填	设备 imei(当设备来自于老平台下 NB 套件产品时，imei 必填，且 device_name 应当为空)
+返回数据
+
+参数名称	类型	描述
+code	int	错误码，当为 0 时表示请求成功，取值见错误码说明表
+msg	string	错误描述信息
+request_id	string	API 请求链路 id
+data	-	具体响应内容
+data.did	int/string	设备 id
+data.pid	string	产品 id
+data.access_pt	int	接入协议，取值见接入协议取值说明表
+data.data_pt	int	数据协议，取值见数据协议取值说明表
+data.name	string	设备名称
+data.desc	string	设备描述
+data.auth_info	---	---
+data.status	int	设备状态，0-离线，1-在线，2-未激活
+data.create_time	datetime	设备创建时间
+data.activate_time	datetime	设备激活时间
+data.last_time	datetime	设备最后一次在线时间
+data.sec_key	string	设备接入鉴权 key
+data.imei	string	LwM2M 设备 imei
+data.imsi	string	LwM2M 设备 imsi
+data.psk	string	LwM2M 设备 psk
+data.auth_code	string	LwM2M 设备 auth_code
+data.intelligent_way	int	产品智能化方式，1-设备接入、2-产品智能化
+data.group_id	string	设备分组 id
+data.enable_status	bool	设备启用状态
+data.tags	string-array	设备标签列表
+data.lon	string	经度
+data.lat	string	纬度
+data.chip	---	---
+data.obsv	bool	设备资源自动订阅是否启用
+data.obsv_st	bool	设备资源自动订阅状态
+data.private	bool	设备私密性
+data.imsi_old	string-array	设备 imsi 历史变更记录
+data.imsi_mt	datetime	设备 imsi 最近一次修改时间
+视联网设备时返回以下字段
+data.viot_device_sn	string	视频设备编码，视联网设备返回
+data.viot_protocol	int	视频设备接入协议，视联网设备返回
+1-GB28181 协议
+2-千里眼协议
+data.viot_device_type	int	视频设备设备类型，视联网设备返回
+1-IPC
+2-NVR
+视联网国标协议设备时返回
+data.viot_sip_server_id	string	SIP 服务器 ID，国标摄像头设备返回
+data.viot_sip_server_domain	string	SIP 服务器域，国标摄像头设备返回
+data.viot_sip_server_ip	string	SIP 服务器 IP，国标摄像头设备返回
+data.viot_sip_server_port	string	SIP 服务器端口，国标摄像头设备返回
+data.viot_login_name	string	登录用户名，国标摄像头设备返回
+data.viot_login_pwd	string	登录密码，国标摄像头设备返回
+视联网千里眼协议设备时返回
+data.viot_module_id	string	设备 modelId，如：cmiot_E4702_002
+data.viot_camera_app_version	string	软件版本，如：2.860.20250512
+data.viot_firmware_version	string	固件版本，如：2.860.20250512
+data.viot_imei	string	千里眼设备 imei（cmei），如：119094672043670
+机卡协同设备上报数据,设备上报后返回
+data.up_iccid	string	设备上报的iccid，如：898604310000000000
+data.up_msisdn	string	设备上报的msisdn，如：+8613800000000
+data.up_sn	string	设备上报的sn
+data.up_imei	string	设备上报的imei，如：119094672043670
+data.up_imsi	string	设备上报的imsi，如：460010000000000
+data.up_mac	string	设备上报的mac，如：08:00:27:01:02:03
+data.up_network	int	设备上报的网络类型，0-非蜂窝网, 1-移动，2-电信，3-联通，4-广电
+示例
+请求示例：
+
+GET https://iot-api.heclouds.com/device/detail?product_id=123&device_name=dname
+响应示例：
+
+{
+    "code": 0,
+    "data": {
+        "did": 2502614722,
+        "pid": "FUSZT1w5t2",
+        "access_pt": 51,
+        "auth_info": "e02efee79b5a-pro",
+        "data_pt": 3,
+        "name": "e02efee79b5a-pro",
+        "desc": "",
+        "status": 1,
+        "create_time": "2025-11-28T09:49:00.613+08:00",
+        "activate_time": "2025-12-01T15:38:51.073+08:00",
+        "last_time": "2025-12-01T15:38:51.073+08:00",
+        "imsi": "",
+        "imei": "",
+        "psk": "",
+        "group_id": "",
+        "enable_status": true,
+        "tags": [],
+        "lat": "",
+        "lon": "",
+        "auth_code": "",
+        "sec_key": "",
+        "chip": 0,
+        "obsv": false,
+        "obsv_st": false,
+        "private": false,
+        "imsi_old": [],
+        "imsi_mt": "0001-01-01T08:05:43+08:05",
+        "intelligent_way": 1,
+        "viot_device_sn": "e02efee79b5a",
+        "viot_protocol": 2,
+        "viot_device_type": 1,
+        "viot_module_id": "cmiot_E4702_002",
+        "viot_camera_app_version": "2.860.20250512",
+        "viot_firmware_version": "2.860.20250512",
+        "viot_imei": "119094672043670"
+    },
+    "msg": "succ",
+    "request_id": "a3d0de892827437b9ad2aa9e6754fb40"
+}