## 消息推送服務
### 接口說明
用戶平臺提供消息接收的url地址,途狐平臺調用該url請求發送數據。途狐平臺采用**POST**方式推送數據。
**注意:用戶平臺正確處理數據后,若返回結果,則需在消息頭中聲明"Content-Type"的值為"application/json;charset=UTF-8"。如{"Content-Type" :"application/json;charset=UTF-8"}**
#### 推送的內容如下:
| 參數 | 類型 | 描述 |
| --- | --- | --- |
| data | String | 消息內容 |
#### data參數列表:
| 參數 | 類型 | 描述 |
| --- | --- | --- |
| address | String | 告警地址(未解析成功時返回null) |
| alarmName | String | 告警名稱 |
| alarmTime | String | 告警時間,格式(yyyy-MM-dd HH:mm:ss) |
| alarmType | String | 告警類型 |
| imei | String | 設備imei |
| lat | String | 緯度(WGS84坐標系) |
| lng | String | 經度(WGS84坐標系) |
| sign| String | 簽名,簽名方式和 [API簽名](/2523135) 一致,供用戶校驗接口使用 |
#### 消息示例:
~~~
https://ip:port/xxx
參數:
"data": {
"address":"浙江省寧波市xxxxx",
"alarmName":"斷電報警",
"alarmTime":"2021-11-22?09:41:46",
"alarmType":"2",
"imei":"867366050xxxxx",
"lat":"29.xxxxxx",
"lng":"121.xxxxxx"
"sign":"326AA85FAAD7BA3A6DAC8B02B098A880"
}
~~~
#### 附1:設備目前支持推送告警類型
| 參數 | 描述 |
| --- | --- |
| 1 | SOS求救 |
| 2 | 斷電報警 |
| 3 | 震動報警 |
| 6 | 超速報警 |
| 1002 | ACC開啟 |
| 1006 | 進入圍欄 |
| 1007 | 離開圍欄 |
#### 附2:Java接收端示例代碼(僅供參考)
~~~
// Map接收方式
@PostMapping(value = "/api/v1/openapi/openApiAlarm/testMap")
public void receive(@RequestBody Map<String, String> data) {
System.out.println(data.toString());
// 可在接收后轉為自定義實體類
OpenApiAlarm openapiAlarmEntity = new OpenApiAlarm();
openapiAlarmEntity = JSONObject.parseObject(data.get("data"), OpenApiAlarm.class);
System.out.println(openapiAlarmEntity.toString());
}
~~~
~~~
// 字符串接收方式
@PostMapping(value = "/api/v1/openapi/openApiAlarm/testString")
public void receive(@RequestBody String data) {
System.out.println(data);
}
~~~
- 目錄
- 概述
- 使用場景
- 使用方法
- 協議格式
- 公共約定
- API簡介
- 通信流程
- API列表
- 接口調用限制說明
- API詳情
- 認證說明
- 通用參數
- 獲取accessToken
- 刷新accessToken
- 注冊設備到平臺
- 根據賬戶獲取設備信息
- 根據賬戶獲取所有設備的最新定位數據
- 根據IMEI獲取最新定位數據
- 根據IMEI獲取設備詳細信息
- 根據IMEI獲取軌跡數據
- 獲取設備支持的指令列表
- 指定設備發送指令
- 獲取設備指令結果
- 根據用戶名獲取分組列表
- 創建分組
- 修改分組信息
- 刪除分組
- 根據賬戶獲取車輛列表
- 根據分組ID獲取車輛列表
- 添加車輛
- 修改車牌
- 轉移車輛(改變分組)
- 獲取圍欄列表
- 獲取圍欄相關車輛
- 新增圍欄
- 刪除圍欄
- 圍欄關聯車輛
- 消息推送