請求方式:POST
URL: http(s)://api.onenet.hk.chinamobile.com/nbiot/execute/offline
參數名稱 | 格式 | 是否必須 | 說明 |
---|---|---|---|
imei | string | 是 | 設備模組IMEI,必填 |
obj_id | int | 是 | nbiot設備的object id, 對應到平台模型中為數據流id,必填 |
obj_inst_id | int | 是 | 設備object下具體一個instance的id ,對應到平台模型中數據點key值的一部分,必填 |
res_id | int | 是 | nbiot設備的資源id,必填 |
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 |
參數名稱 | 格式 | 是否必須 | 說明 |
---|---|---|---|
args | string | 否 | 命令字串,大小限制2k |
參數名稱 | 格式 | 說明 |
---|---|---|
errno | int | 調用錯誤碼,為0表示調用成功 |
error | string | 錯誤描述,為"succ"表示調用成功 |
data | json | 介面調用成功之後返回的設備相關信息,見data描述表 |
參數名稱 | 格式 | 說明 |
---|---|---|
uuid | string | 緩存命令uuid |
1、返回errno狀態碼所對應的含義,可以查看API狀態碼。
2、HTTP內容部分選填。
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/execute/offline?imei=86582003***&valid_time=2016-08-05T08:00:00&expired_time=2016-08-06T08:00:00&obj_id=1212&obj_inst_id=1212&res_id=123 HTTP/1.1
api-key: WhI*************v1c= //必須為 MasterKey, 由於涉及個人隱私, 這裡用“*******” 代替
POST data
{
"args":"ping" //字串
} //HTTP 内容部分選填
{
"errno": 0,
"data": {
"uuid":"42742677-adc3-54ca-83a1-5aaaf71482f8" ////緩存命令uuid
},
"error": "succ"
} //回應訊息中errno表示錯誤碼,error表示錯誤原因。