# 好望云摄像机告警消息回调（API名称：ivmAlarm/alarmMsg）
#### 功能介绍
仅供好望云订阅，用于摄像机告警消息回调。
#### 相关接口
| **接口名称**                                                             | **调用说明**                                                     |
|:---|:---|
| [获取Token](https://support.huaweicloud.com/api-isdp/api_01_0019.html) | 调用该接口获取到Token，再调用其他接口时，需要在请求消息头中添加"Authorization"，其值即为Token。 |
   
#### URL
| **请求方式** | **HTTPS地址**                                        | **服务架构** | **消息体类型**        |
|:---|:---|:---|:---|
| POST     | https://***isdp+域名***/openapi/v1/ivmAlarm/alarmMsg | OpenAPI  | application/json |
   
#### 请求头
| **KEY**       | VALUE                  | 是否必填 | **描述**                                                                                           |
|:---|:---|:---|:---|
| Content-Type  | application/json       | 是    | 无                                                                                                |
| Authorization | bearer ${access_token} | 是    | bearer +" "+[5.2.1](https://support.huaweicloud.com/api-isdp/api_01_0019.html)中获取的access_token的值 |
   
#### 请求参数
| **参数**          | **类型** | **是否必填** | **描述** |
|:---|:---|:---|:---|
| message_id      | Int    | 是        | 消息ID   |
| message_type    | String | 是        | 消息类型   |
| device_id       | String | 是        | 设备编号   |
| device_name     | String | 是        | 设备名称   |
| channel_type    | String | 否        | 通道类型   |
| channel_id      | String | 否        | 通道ID   |
| channel_name    | String | 否        | 通道名称   |
| alarm_type      | String | 否        | 告警类型   |
| alarm_status    | String | 否        | 告警状态   |
| alarm_time      | String | 否        | 告警时间   |
| alarm_uuid      | String | 否        | 告警唯一标识 |
| expire_time_utc | String | 否        | 超时时间   |
| classification  | String | 否        | 告警种类   |
| alarm_type_name | String | 否        | 告警类型名称 |
| users           | String | 否        | 用户ID   |
   
#### 响应参数
| **字段名** | **数据类型** |     **描述**     |
|---|---|---|
| status  | int      | 返回状态：0-成功;1-失败 |
| message | String   | 返回的失败消息。       |
   
#### 请求示例
```
{
    "message_id": 1602817486772985497,
    "message_type": "device_alarm",
    "data": {
        "device_id": "2198061243WLL4002533",
        "device_name": "Huawei HoloSens NVR800",
        "channel_type": "video_input",
        "channel_id": 2,
        "channel_name": "HoloSens SDC",
        "alarm_type": "people_count_line_alarm",
        "alarm_status": "start",
        "alarm_time": "2020-10-16T11:04:47+08:00",
        "alarm_uuid": "2198061243WLL4002533_1_people_count_line_alarm_20201016110447_11",
        "expire_time_utc": "2020-10-23 03:04:46",
        "classification": "crowd_line",
        "alarm_type_name": "",
        "users": null
    }
}
```
#### 响应示例
```
{
    "status": 1,
    "message": "SUCCESS",
    "error": null,
    "data": "",
    "timestamp": "2021-04-01T17:16:10.750+0800"
}
```