緩存命令-寫設備資源/Write
請求方式:POST
URL: http(s)://api.onenet.hk.chinamobile.com/nbiot/offline
我只想看示例!!!
url參數
參數名稱 | 格式 | 是否必須 | 說明 |
imei | string | 是 | nbiot設備的身份碼,必填 |
obj_id | int | 是 | 設備的object id, 對應到平台模型中為數據流id,必填 |
obj_inst_id | int | 是 | nbiot設備object下具體一個instance的id ,對應到平台模型中數據點key值的一部分,必填
|
mode | int | 是 | write的寫模式,只能是1或者2 |
valid_time | string | 否 | 命命令開始生效時間,可選(不填時默認為OneNET當前時間),填寫必須大於OneNET伺服器的當前時間
|
expired_time | string | 是 | 命令過期時間戳記,必填且大於valid_time |
retry | int | 否 | [0-10]之間,表示失敗重試次數(等待下一次設備update 或者上線),可選(不填時默認為3),填寫時必須在[0, 10]之間 |
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 |
說明
返回errno狀態碼所對應的含義,可以查看API狀態碼。
trigger_msg 觸發類型:
1: REGISTER
2: UPDATE
3: REGISTER | UPDATE 組合
4: NOTIFY
5: REGISTER | NOTIFY 組合
6: UPDATE | NOTIFY 組合
7: NOTIFY | UPDATE | REGISTER 組合
請求示例
POST http://api.onenet.hk.chinamobile.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= //必須為 MasterKey, 由於涉及個人隱私, 這裡用“*******” 代替
Content-Type: application/json
請求參數示例
非opaque類型:
{
"data":[
{
"res_id":12,
"val":121
}
]
}
opaque類型:
{
"data":[
{
"res_id":12,
"type":1,
"val":"121A"
}
]
}
返回示例
{
"errno": 0,
"error":"succ",
"data":
{
"uuid":"42742677-adc3-54ca-83a1-5aaaf71482f8"
}
}