請求方式:GET
URL: http(s)://api.onenet.hk.chinamobile.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.onenet.hk.chinamobile.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 表示錯誤原因。