请求方式:GET
URL: http(s)://api.heclouds.com/nbiot/offline
参数名称 | 格式 | 是否必须 | 说明 |
---|---|---|---|
imei | string | 是 | nbiot设备的身份码,必填 |
obj_id | int | 是 | 设备的object id , 对应到平台模型中为数据流id,必填 |
obj_inst_id | int | 否 | nbiot设备object下具体一个instance的id ,对应到平台模型中数据点key值的一部分,选填 |
res_id | int | 否 | nbiot设备的资源id,选填 |
valid_time | string | 否 | 命令开始生效时间,可选(不填时默认为OneNET当前时间),填写必须大于OneNET服务器的当前时间 |
expired_time | string | 是 | 命令过期时间,必须大于valid_time |
retry | int | 否 | 表示失败重试次数(等待下一次设备update或者上线),可选(不填时默认为3),填写时必须在[0, 10]之间 |
timeout | int | 否 | 过期时间,填写时必须在[5,40]s之间;不填写默认为25s |
trigger_msg | int | 否 | 命令触发的上行消息类型,填写时必须在[1,7]之间;不填写默认为7 |
bin2hex | boolean | 否 | true|false,默认false,如果bin2hex为true,资源类型为Opaque的值将被转换成十六进制字符串返回 |
参数名称 | 格式 | 说明 |
---|---|---|
errno | int | 调用错误码,为0表示调用成功 |
error | string | 错误描述,为"succ"表示调用成功 |
data | json | 接口调用成功之后返回的设备相关信息,见data描述表 |
参数名称 | 格式 | 说明 |
---|---|---|
uuid | string | 缓存命令uuid |
1、返回errno状态码所对应的含义,可以查看API状态码。
2、valid_time和expired_time格式为:"2018-03-08T17:30:00"
trigger_msg 触发类型:
1. REGISTER
2. UPDATE
3. REGISTER | UPDATE 组合
4. NOTIFY
5. REGISTER | NOTIFY 组合
6. UPDATE | NOTIFY 组合
7. NOTIFY | UPDATE | REGISTER 组合
GET http://api.heclouds.com/nbiot/offline HTTP/1.1
api-key:xxxx-ffff-zzzzz //必须为 MasterKey, 由于涉及个人隐私, 这里用“*******” 代替
{
"imei":121, // nbiot设备的身份码,必填
"obj_id":1212, // 设备的object id , 对应到平台模型中为数据流id,必填
"obj_inst_id": 1212, // nbiot设备object下具体一个instance的id ,对应到平台模型中数据点key值的一部分,选填
"res_id": 2122, // nbiot设备的资源id,选填
"valid_time":"2018-03-08T17:30:00",// 命令开始生效时间,可选(不填时默认为OneNET当前时间),填写必须大于OneNET服务器的当前时间
"expired_time": "2018-03-09T17:30:00",// 命令过期时间,必填且大于valid_time
"retry":3, // 表示失败重试次数(等待下一次设备update或者上线),可选(不填时默认为3),填写时必须在[3, 10]之间
"bin2hex": true// 可选,取值为true|false,默认false,如果bin2hex为true,资源类型为Opaque的值将被转换成十六进制字符串返回
}
{
"errno": 0,
"error":"succ",
"data":
{
"uuid":"42742677-adc3-54ca-83a1-5aaaf71482f8"//缓存命令uuid
}
} //响应消息中 errno 表示错误码,error 表示错误原因。