創建回調規則
更新時間 2024-09-11 16:11:34
最近更新時間: 2024-09-11 16:11:34
分享文章
接口功能介紹
本接口用于創建回調規則,即綁定回調模板至設備。
接口約束
創建回調規則確保存在該回調模板以及需要綁定的設備。
請求參數說明:
String類型的參數,傳""等同于不傳。
Integer類型的參數,傳0等同于不傳。
Boolean類型的參數,傳false等同于不傳。
URI
POST /v2/callbackTemplate/*/callbackRule
路徑參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| TemplateId | 是 | String | 模板ID。 | 739943519892963328 |
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| DeviceId | 是 | String | 設備ID。 | 700576974938832896 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 響應狀態碼。 | 200 | |
| error | String | 錯誤碼,執行成功時,不返回該字段。 | VSS_0001 | |
| message | String | 響應信息。 | 請求成功 | |
| requestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 響應數據,執行失敗時,不返回該字段。 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| TemplateId | String | 模板ID。 | 739943519892963328 | |
| DeviceId | String | 設備ID。 | 700576974938832896 | |
| CreatedTime | String | 回調規則創建時間。 | 1691995152 | |
| UpdatedTime | String | 回調規則更新時間。 | 1691995152 | |
| RequestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b |
枚舉參數
無
請求示例
請求url
POST '/v2/callbackTemplate/739943519892963328/callbackRule'
請求頭header
無
請求體body
{"DeviceId": "700576974938832896"}
響應示例
{"statusCode": 200,"message": "請求成功","requestId": "20b464ca3a4640ec8f11b39d9d106a2e","returnObj": {"TemplateId": "739943519892963328","DeviceId": "700576974938832896","CreatedTime": "1691995152","UpdatedTime": "1691995152","RequestId": "20b464ca3a4640ec8f11b39d9d106a2e"}}
狀態碼
請參考
錯誤碼
請參考