接口介绍
根据APPID和设备编号获取IOT设备详细信息。
参数简介
公共参数
参数名 |
参数类型 |
参数介绍 |
是否必填 |
command |
String(32) |
接口名,固定为:open.api.iot.device.detail |
是 |
app_id |
String(32) |
应用ID |
是 |
device_no |
String(32) |
设备唯一标识 |
是 |
version |
String(16) |
调用的接口版本,固定为:1.0 |
是 |
sign_type |
String(32) |
签名类型, 固定为:MD5 |
否 |
request_id |
String(64) |
请求报文ID,唯一定位一次报文请求,由发起方生成,应答方原样返回,uuid生成,全局唯一 |
是 |
request_time |
String(32) |
请求发起时间,格式:yyyyMMddHHmmss,请求发起时间,应答方原样返回 |
是 |
sign |
String(32) |
签名,详见MD5签名 |
是 |
参数简介
返回值说明
公共返回值
参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
success |
result |
boolean |
标识这次请求是否成功 |
请不要用这个值来判断收银是否成功,订单的结果以返回的order_status为准。 |
error_code |
result |
String(64) |
错误码 |
|
error_msg |
result |
String(16) |
错误码的详细说明 |
|
app_id |
data |
String(32) |
应用ID |
|
device_no |
data |
String(64) |
设备唯一标识 |
|
request_id |
data |
String(64) |
请求报文ID |
|
request_time |
data |
String(32) |
请求发起时间,格式:yyyyMMddHHmmss |
|
response_time |
data |
String(32) |
请求返回时间,格式:yyyyMMddHHmmss |
|
sign |
sign |
String |
签名值 |
具体参照: 接口验签规则 |
数据返回值
参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
server |
data |
String(128) |
设备mqtt服务器地址 |
|
topic |
data |
String(128) |
消息订阅主题 |
|
client_id |
data |
String(64) |
客户端ID |
|
password |
data |
String(128) |
设备用户密码 |
|
user_name |
data |
String(128) |
设备用户名称 |
返回值示例
{
"data":{
"app_id":"BOPU_IOT_CLOUD_HORN",
"client_id":"S00001",
"device_no":"S00001",
"password":"E681F1E33526685214783A435FDD072F",
"request_id":"2184568e-2a65-4b46-bb1c-5aa60889aac7",
"request_time":"20210617152848",
"response_time":"20210617162045",
"server":"tcp://a1FbhL2MUU8.iot-as-mqtt.cn-shanghai.aliyuncs.com:1883",
"topic":"/a1FbhL2MUU8/S00001/user/report",
"user_name":"S00001&a1FbhL2MUU8"
},
"result":{
"success":true
},
"sign":"SThe303UbCmymAp8a1OjbgZPY3PjO7L/ghqAJ+/FEN3uW0eD/kdqRlkNVBSPjGfCyQGiXkv10enDdCUd8ElRsMHmNFQ0B6JJbc6Cwm6CpXoJ/rC57cmMxd53IhLcfFj+k3MS0sgoeeGdGigxBFAdGIM01Ax3BqBe8Ml8qNeyUi/5qDF0P+hlaAFkkxXrxuVb+NdmZ0SYcYlZXRWJi+pgR5JsB5hYHQLYf5n/DD3DWsbpYd77mTBV4UdLlaRR22B1ZQo2lXSnRNxKqyM06RrNkzIqk76w1n7RpAr+zkRTUGUcLGJkiV4tMqvIN3m6p/3WfmSdsyo8aGsOjmEE5+cw0g=="
}
Js Demo
http://openapi.pre.caibaopay.com/test/api/iot/iotDeviceDetail.htm