消息中心服务
## 概述
> 消息中心服务
类名
`
MessageApi.java
`
成员方法
名称 | 方法 | Method | Path
------------- | ------------- | ------------- | -------------
[清除声光报警](#clearShengGuangAlarm) | [**clearShengGuangAlarm**](#clearShengGuangAlarm) | POST | /api-organization/message/clearAcoustoOpticAlarm
[清除当前用户所有报警分组](#deleteMessageGroup) | [**deleteMessageGroup**](#deleteMessageGroup) | POST | /api-organization/message/deleteMessageGroup
[查询公司的声光报警声音路径](#getAcoustoopticPath) | [**getAcoustoopticPath**](#getAcoustoopticPath) | POST | /api-organization/message/getAcoustoOpticPath
[获取当前用户消息收藏分组](#getMessageGroupInfo) | [**getMessageGroupInfo**](#getMessageGroupInfo) | POST | /api-organization/message/getMessageGroupInfo
[获取消息接收管理消息类型及推送方式](#getSystemMessageType) | [**getSystemMessageType**](#getSystemMessageType) | POST | /api-organization/message/getSystemMessageType
[ 查询用户是否含有声光报警信息](#getacoustoopticMessage) | [**getacoustoopticMessage**](#getacoustoopticMessage) | POST | /api-organization/message/getAcoustoOpticMessage
[恢复默认声光报警为默认](#resetAcoustooptic) | [**resetAcoustooptic**](#resetAcoustooptic) | POST | /api-organization/message/resetAcoustooptic
[更换声光报警的音频文件](#updateAcoustoopticFile) | [**updateAcoustoopticFile**](#updateAcoustoopticFile) | POST | /api-organization/message/updateAcoustoopticFile
[修改当前用户选中的收藏分组](#updateMessageGroup) | [**updateMessageGroup**](#updateMessageGroup) | POST | /api-organization/message/updateMessageGroup
<a id="clearShengGuangAlarm"></a>
## **清除声光报警**
> ResultObject clearShengGuangAlarm()
### 请求参数
请求参数为空.
### 返回参数
ResultObject
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **Object** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
### java-sdk 调用示例
```java
//实例化api类，传入token
MessageApi apiInstance = new MessageApi(token);
try {
ResultObject result = apiInstance.clearShengGuangAlarm();
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用MessageApi.clearShengGuangAlarm异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/message/clearAcoustoOpticAlarm|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{}
```
<a id="deleteMessageGroup"></a>
## **清除当前用户所有报警分组**
> ResultObject deleteMessageGroup()
### 请求参数
请求参数为空.
### 返回参数
ResultObject
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **Object** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
### java-sdk 调用示例
```java
//实例化api类，传入token
MessageApi apiInstance = new MessageApi(token);
try {
ResultObject result = apiInstance.deleteMessageGroup();
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用MessageApi.deleteMessageGroup异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/message/deleteMessageGroup|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{}
```
<a id="getAcoustoopticPath"></a>
## **查询公司的声光报警声音路径**
> ResultString getAcoustoopticPath()
### 请求参数
请求参数为空.
### 返回参数
ResultString
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **String** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
### java-sdk 调用示例
```java
//实例化api类，传入token
MessageApi apiInstance = new MessageApi(token);
try {
ResultString result = apiInstance.getAcoustoopticPath();
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用MessageApi.getAcoustoopticPath异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/message/getAcoustoOpticPath|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{}
```
<a id="getMessageGroupInfo"></a>
## **获取当前用户消息收藏分组**
> ResultListMessageAlarmGroupVo getMessageGroupInfo()
### 请求参数
请求参数为空.
### 返回参数
ResultListMessageAlarmGroupVo
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **List<MessageAlarmGroupVo>** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
MessageAlarmGroupVo
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**flag** | **Boolean** | 标记 | -
**index** | **Integer** | 位置 | -
**status** | **Boolean** | 状态 | -
### java-sdk 调用示例
```java
//实例化api类，传入token
MessageApi apiInstance = new MessageApi(token);
try {
ResultListMessageAlarmGroupVo result = apiInstance.getMessageGroupInfo();
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用MessageApi.getMessageGroupInfo异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/message/getMessageGroupInfo|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{}
```
<a id="getSystemMessageType"></a>
## **获取消息接收管理消息类型及推送方式**
> ResultListMessageRecevieVo getSystemMessageType()
### 请求参数
请求参数为空.
### 返回参数
ResultListMessageRecevieVo
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **List<MessageRecevieVo>** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
MessageRecevieVo
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**flag** | **Boolean** | 推送管理标识 | -
**messageTypeId** | **String** | 消息类型id | -
**name** | **String** | 消息类型名称 | -
**projectId** | **String** | 项目id | -
**pushway** | **String** | 消息推送方式 | -
**regulationId** | **String** | 规则id | -
**roleId** | **String** | 角色id | -
**subject** | **String** | 消息主题 | -
**userId** | **String** | 员工id | -
### java-sdk 调用示例
```java
//实例化api类，传入token
MessageApi apiInstance = new MessageApi(token);
try {
ResultListMessageRecevieVo result = apiInstance.getSystemMessageType();
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用MessageApi.getSystemMessageType异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/message/getSystemMessageType|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{}
```
<a id="getacoustoopticMessage"></a>
## ** 查询用户是否含有声光报警信息**
> ResultObject getacoustoopticMessage()
### 请求参数
请求参数为空.
### 返回参数
ResultObject
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **Object** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
### java-sdk 调用示例
```java
//实例化api类，传入token
MessageApi apiInstance = new MessageApi(token);
try {
ResultObject result = apiInstance.getacoustoopticMessage();
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用MessageApi.getacoustoopticMessage异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/message/getAcoustoOpticMessage|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{}
```
<a id="resetAcoustooptic"></a>
## **恢复默认声光报警为默认**
> ResultObject resetAcoustooptic()
### 请求参数
请求参数为空.
### 返回参数
ResultObject
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **Object** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
### java-sdk 调用示例
```java
//实例化api类，传入token
MessageApi apiInstance = new MessageApi(token);
try {
ResultObject result = apiInstance.resetAcoustooptic();
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用MessageApi.resetAcoustooptic异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/message/resetAcoustooptic|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{}
```
<a id="updateAcoustoopticFile"></a>
## **更换声光报警的音频文件**
> ResultObject updateAcoustoopticFile()
### 请求参数
请求参数为空.
### 返回参数
ResultObject
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **Object** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
### java-sdk 调用示例
```java
//实例化api类，传入token
MessageApi apiInstance = new MessageApi(token);
try {
ResultObject result = apiInstance.updateAcoustoopticFile();
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用MessageApi.updateAcoustoopticFile异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/message/updateAcoustoopticFile|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{}
```
<a id="updateMessageGroup"></a>
## **修改当前用户选中的收藏分组**
> Result updateMessageGroup(flag, index)
### 请求参数
名称 | 类型 | 描述 | 备注
------------- | ------------- | ------------- | -------------
**flag** | **Boolean**| 是否选中 |
**index** | **Integer**| 收藏分组下标 |
### 返回参数
Result
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | | -
**data** | **Object** | | -
**msg** | **String** | | -
**time** | **OffsetDateTime** | | -
### java-sdk 调用示例
```java
//实例化api类，传入token
MessageApi apiInstance = new MessageApi(token);
//实例化请求参数
Boolean flag = true;
Integer index = 56;
try {
Result result = apiInstance.updateMessageGroup(flag, index);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用MessageApi.updateMessageGroup异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/message/updateMessageGroup|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{
"index":0
}
```