版本：V4.0

警報管理API

獲取警報配置

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object	Body	是	命令參數

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	[]Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
low_power	Object<low_power>	Body	低電量警報
sos_alarm	Object<sos_alarm>	Body	SOS警報
smoke_alarm	Object<smoke_alarm>	Body	煙霧警報
co_alarm	Object<co_alarm>	Body	一氧化碳警報
gas_alarm	Object<gas_alarm>	Body	燃氣警報
moist_alarm	Object<moist_alarm>	Body	水浸警報
door_open_alarm	Object<door_open_alarm>	Body	門開啓警報

low_power說明

參數名	類型	位置	說明
record	Boolean	Body	判斷是否記錄 true：是 false：否
web_popup	Boolean	Body	判斷是否網頁彈窗 true：是 false：否

sos_alarm說明

參數名	類型	位置	說明
record	Boolean	Body	判斷是否記錄 true：是 false：否
web_popup	Boolean	Body	判斷是否網頁彈窗 true：是 false：否

smoke_alarm說明

參數名	類型	位置	說明
record	Boolean	Body	判斷是否記錄 true：是 false：否
web_popup	Boolean	Body	判斷是否網頁彈窗 true：是 false：否

co_alarm說明

參數名	類型	位置	說明
record	Boolean	Body	判斷是否記錄 true：是 false：否
web_popup	Boolean	Body	判斷是否網頁彈窗 true：是 false：否

gas_alarm說明

參數名	類型	位置	說明
record	Boolean	Body	判斷是否記錄 true：是 false：否
web_popup	Boolean	Body	判斷是否網頁彈窗 true：是 false：否

moist_alarm說明

參數名	類型	位置	說明
record	Boolean	Body	判斷是否記錄 true：是 false：否
web_popup	Boolean	Body	判斷是否網頁彈窗 true：是 false：否

door_open_alarm說明

參數名	類型	位置	說明
record	Boolean	Body	判斷是否記錄 true：是 false：否
web_popup	Boolean	Body	判斷是否網頁彈窗 true：是 false：否
only_check_out	Boolean	Body	判斷是否在僅退房情況下觸發 true：是 false：否
duration	String	Body	持續時間 now：立刻 30min：30分鐘 1h：1小時 2h：2小時 6h：6小時 12h：12小時 24h：24小時 48h：48小時

請求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_alarm_config",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {}
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": {
    "low_power": {
      "record": true,
      "web_popup": false
    },
    "sos_alarm": {
      "record": true,
      "web_popup": false
    },
    "smoke_alarm": {
      "record": true,
      "web_popup": false
    },
    "co_alarm": {
      "record": true,
      "web_popup": false
    },
    "gas_alarm": {
      "record": true,
      "web_popup": false
    },
    "moist_alarm": {
      "record": true,
      "web_popup": false
    },
    "door_open_alarm": {
      "record": true,
      "web_popup": false,
      "only_check_out": true,
      "duration": "now"
    }
  }
}

失敗返回示例

見接口失敗返回

更新警報配置

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
low_power	Object<low_power>	Body	是	低電量警報
sos_alarm	Object<sos_alarm>	Body	是	SOS警報
smoke_alarm	Object<smoke_alarm>	Body	是	煙霧警報
co_alarm	Object<co_alarm>	Body	是	一氧化碳警報
gas_alarm	Object<gas_alarm>	Body	是	燃氣警報
moist_alarm	Object<moist_alarm>	Body	是	水浸警報
door_open_alarm	Object<door_open_alarm>	Body	是	門開啓警報

low_power說明

參數名	類型	位置	必填	說明
record	Boolean	Body	是	判斷是否記錄 true：是 false：否
web_popup	Boolean	Body	是	判斷是否網頁彈窗 true：是 false：否

sos_alarm說明

參數名	類型	位置	必填	說明
record	Boolean	Body	是	判斷是否記錄 true：是 false：否
web_popup	Boolean	Body	是	判斷是否網頁彈窗 true：是 false：否

smoke_alarm說明

參數名	類型	位置	必填	說明
record	Boolean	Body	是	判斷是否記錄 true：是 false：否
web_popup	Boolean	Body	是	判斷是否網頁彈窗 true：是 false：否

co_alarm說明

參數名	類型	位置	必填	說明
record	Boolean	Body	是	判斷是否記錄 true：是 false：否
web_popup	Boolean	Body	是	判斷是否網頁彈窗 true：是 false：否

gas_alarm說明

參數名	類型	位置	必填	說明
record	Boolean	Body	是	判斷是否記錄 true：是 false：否
web_popup	Boolean	Body	是	判斷是否網頁彈窗 true：是 false：否

moist_alarm說明

參數名	類型	位置	必填	說明
record	Boolean	Body	是	判斷是否記錄 true：是 false：否
web_popup	Boolean	Body	是	判斷是否網頁彈窗 true：是 false：否

door_open_alarm說明

參數名	類型	位置	必填	說明
record	Boolean	Body	是	判斷是否記錄 true：是 false：否
web_popup	Boolean	Body	是	判斷是否網頁彈窗 true：是 false：否
only_check_out	Boolean	Body	是	判斷是否在僅退房情況下觸發 true：是 false：否
duration	String	Body	是	持續時間 now：立刻 30min：30分鐘 1h：1小時 2h：2小時 6h：6小時 12h：12小時 24h：24小時 48h：48小時

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_alarm_config",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "low_power": {
      "record": true,
      "web_popup": false
    },
    "sos_alarm": {
      "record": true,
      "web_popup": false
    },
    "smoke_alarm": {
      "record": true,
      "web_popup": false
    },
    "co_alarm": {
      "record": true,
      "web_popup": false
    },
    "gas_alarm": {
      "record": true,
      "web_popup": false
    },
    "moist_alarm": {
      "record": true,
      "web_popup": false
    },
    "door_open_alarm": {
      "record": true,
      "web_popup": false,
      "only_check_out": true,
      "duration": "now"
    }
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": {}
}

失敗返回示例

見接口失敗返回

獲取警報記錄列表

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
page_size	Integer	Body	是	每頁數量
page_index	Integer	Body	是	當前頁數

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	[]Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
alarm_time	String	Body	警報時間，UTC
alarm_type	String	Body	警報類型 low_power：低電量警報 sos_alarm：SOS警報 smoke_alarm：煙霧警報 co_alarm：一氧化碳警報 gas_alarm：燃氣警報 moist_alarm：水浸警報 door_open_alarm：門開啓警報
residence_id	String	Body	住宅ID

請求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_alarm_record_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": [
    {
      "alarm_time": "2025-01-16 15:10:43",
      "alarm_type": "smoke_alarm",
      "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
    }
  ]
}

失敗返回示例

見接口失敗返回

獲取警報配置​

接口地址​

請求參數​

返回參數​

result說明​

low_power說明​

sos_alarm說明​

smoke_alarm說明​

co_alarm說明​

gas_alarm說明​

moist_alarm說明​

door_open_alarm說明​

請求示例​

成功返回示例​

失敗返回示例​

更新警報配置​

接口地址​

請求參數​

param說明​

low_power說明​

sos_alarm說明​

smoke_alarm說明​

co_alarm說明​

gas_alarm說明​

moist_alarm說明​

door_open_alarm說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

獲取警報記錄列表​

接口地址​

請求參數​

param說明​

返回參數​

result說明​

請求示例​

成功返回示例​

失敗返回示例​

獲取警報配置

接口地址

請求參數

返回參數

result說明

low_power說明

sos_alarm說明

smoke_alarm說明

co_alarm說明

gas_alarm說明

moist_alarm說明

door_open_alarm說明

請求示例

成功返回示例

失敗返回示例

更新警報配置

接口地址

請求參數

param說明

low_power說明

sos_alarm說明

smoke_alarm說明

co_alarm說明

gas_alarm說明

moist_alarm說明

door_open_alarm說明

返回參數

請求示例

成功返回示例

失敗返回示例

獲取警報記錄列表

接口地址

請求參數

param說明

返回參數

result說明

請求示例

成功返回示例

失敗返回示例