缓存命令-写设备资源/Write
请求方式:POST
URL: http://api.heclouds.com/nbiot/offline
url参数
参数名称 |
格式 |
是否必须 |
说明 |
imei |
string |
是 |
nbiot设备的身份码 |
obj_id |
int |
是 |
nbiot设备的object id , 对应到平台模型中为数据流id |
obj_inst_id |
int |
是 |
设备object下具体一个instance的id ,对应到平台模型中数据点key值的一部分 |
mode |
int |
是 |
write的写模式,只能是1或者2 |
valid_time |
string |
否 |
命令开始生效时间戳,可选(不填时默认为OneNET当前时间) |
expired_time |
string |
是 |
命令过期时间戳,必须大于valid_time |
retry |
int |
否 |
[0 10]之间,表示失败重试次数(等待下一次设备update或者上线),默认为3 |
timeout |
int |
否 |
过期时间,填写时必须在[5,40]s之间;不填写默认为25s |
trigger_msg |
int |
否 |
命令触发的上行消息类型,填写时必须在[1,7]之间;不填写默认为7 |
http请求参数
参数名称 |
格式 |
是否必须 |
说明 |
data |
array-json |
是 |
写设备资源的json数组,大小限制2k,见data请求参数描述表 |
data请求参数描述表
参数名称 |
格式 |
是否必须 |
说明 |
res_id |
int |
是 |
nbiot设备的资源id |
type |
int |
否 |
目前支持为1 和 2,1代表该资源type为Opaque,此时val字段为该二进制对应的十六进制字符串;2代表该资源type为Time,此时val字段为时间戳(单位为秒,数值);不写代表该资源type为基础数据类型 |
val |
object |
是 |
值,可为boolean、string、long、double |
返回参数
参数名称 |
格式 |
说明 |
errno |
int |
调用错误码,为0表示调用成功 |
error |
string |
错误描述,为"succ"表示调用成功 |
data |
json |
接口调用成功之后返回的相关信息,见data描述表 |
data描述表
参数名称 |
格式 |
说明 |
uuid |
string |
离线命令uuid |
说明
trigger_msg 触发类型:
1. REGISTER
2. UPDATE
3. REGISTER | UPDATE 组合
4. NOTIFY
5. REGISTER | NOTIFY 组合
6. UPDATE | NOTIFY 组合
7. NOTIFY | UPDATE | REGISTER 组合
请求示例
POST http://api.heclouds.com/nbiot/offline?imei=86582003***&valid_time=2016-08-05T08:00:00&expired_time=2016-08-06T08:00:00&obj_id=1212&obj_inst_id=1212&mode=1 HTTP/1.1
api-key: WhI*************v1c=
Content-Type: application/json
Host: api.heclouds.com
请求参数示例
非opaque类型:
{
"data":[
{
"res_id":12,
"val":121
}
]
}
opaque类型:
{
"data":[
{
"res_id":12,
"type":1,
"val":"121A"
}
]
}
返回示例
{
"errno": 0,
"data": {
"uuid":"42742677-adc3-54ca-83a1-5aaaf71482f8"
},
"error": "succ"
}