设备告警订阅
接口功能
设备告警、AI 事件订阅
请求地址
TEXT
https://open.qly.cmviot.cn/v3/open/api/app/alarm/subscribe请求方式
POST,需要鉴权
请求参数
| 参数名称 | 参数类型 | 是否必需 | 参数含义 | 说明 |
|---|---|---|---|---|
| subscribeInfos | List<subscribeInfo> | Y | 订阅信息集合 | 最大 30 条 |
subscribeInfo
| 参数名称 | 参数类型 | 是否必需 | 参数含义 | 说明 |
|---|---|---|---|---|
| deviceId | String | Y | 设备 id | |
| event | String | N | 订阅事件集合 | 为空或者不传,则为取消订阅;需订阅新事件,请带上历史订阅的事件,若仅传新事件名,代表仅订阅该事件 |
event 可选类型如下:
- motion(运动告警)
- sound(声音告警)
- regional_invasion(区域入侵)
- border_intrusion(边界入侵)
- cross_border_detection(越界侦测)
- face_snap(人脸抓拍)
- face_recognition(人脸识别结果)
- ai (AI 事件消息)
- car_snap(车辆抓拍)
- car_recognition(车辆识别)
- human(人形告警)
event 格式: 一个 json 字符串数组。例如: ["motion","sound"],然后将 json 格式化成字符串,填入参数。
请求示例
json
{
"subscribeInfos": [
{ "deviceId": "xxxxS_12341234adf", "event": "[\"motion\",\"sound\"]" }
]
}响应参数
| 参数名称 | 参数类型 | 参数含义 | 说明 |
|---|---|---|---|
| resultCode | String | 响应码 | 参考响应码定义 |
| resultMsg | String | 响应描述 |
响应示例
json
{
"resultCode": "000000",
"resultMsg": "成功"
}