版本：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说明

请求示例

成功返回示例

失败返回示例