消息中心服务

# 概述

消息中心API 以确保消息提示的准确性，为此开发了消息中心该模块主要用于将报警等提示进行统一显示该API提供了获取消息接收管理消息类型及推送方式、更换声光报警音频等功能

类名

MessageApi.java

成员方法

名称	方法	Method	Path
清除声光报警和已读消息	clearAcoustoOpticAndReadMessageParam	POST	/api-organization/message/clearAcoustoOpticAndReadMessageParam
根据用户手机号查询手机号推送时间限制	clearPushTimeLimit	POST	/api-organization/message/clearPushTimeLimit
清除声光报警	clearShengGuangAlarm	POST	/api-organization/message/clearAcoustoOpticAlarm
恢复默认声光报警为默认	defaultMusicAcoustooptic	POST	/api-organization/message/defaultMusicAcoustooptic
清除当前用户所有报警分组	deleteMessageGroup	POST	/api-organization/message/deleteMessageGroup
查询公司的声光报警声音路径	getAcoustoOptic	POST	/api-organization/message/getAcoustooptic
获取当前用户消息收藏分组	getMessageGroupInfo	POST	/api-organization/message/getMessageGroupInfo
根据用户手机号查询手机号推送时间限制	getPushTimeLimit	POST	/api-organization/message/getPushTimeLimit
获取消息接收管理消息类型及推送方式	getSystemMessageType	POST	/api-organization/message/getSystemMessageType
查询用户是否含有声光报警信息	getacoustoopticMessage	POST	/api-organization/message/getAcoustoOpticMessage
根据用户手机号查询手机号推送时间限制	saveOrUpdatePushTimeLimit	POST	/api-organization/message/saveOrUpdatePushTimeLimit
修改声光设置	updateAcoustoOptic	POST	/api-organization/message/updateAcoustoOptic
更换声光报警的音频文件	updateAcoustoopticFile	POST	/api-organization/message/updateAcoustoopticFile
修改当前用户选中的收藏分组	updateMessageGroup	POST	/api-organization/message/updateMessageGroup

# 清除声光报警和已读消息

ResultObject clearAcoustoOpticAndReadMessageParam(clearAcoustoOpticAndReadMessageForm)

# 请求参数

名称	类型	描述	备注
clearAcoustoOpticAndReadMessageForm	ClearAcoustoOpticAndReadMessageForm	clearAcoustoOpticAndReadMessageForm

# ClearAcoustoOpticAndReadMessageForm

名称	类型	描述	备注
alarmId	String	报警ID	-
messageId	String	消息ID	-
projectId	String	项目ID	-

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
MessageApi apiInstance = new MessageApi(token);
//实例化请求参数
ClearAcoustoOpticAndReadMessageForm clearAcoustoOpticAndReadMessageForm = new ClearAcoustoOpticAndReadMessageForm();

try {
    ResultObject result = apiInstance.clearAcoustoOpticAndReadMessageParam(clearAcoustoOpticAndReadMessageForm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用MessageApi.clearAcoustoOpticAndReadMessageParam异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/message/clearAcoustoOpticAndReadMessageParam
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"alarmId":"",
	"messageId":"",
	"projectId":""
}

1
2
3
4
5

# 根据用户手机号查询手机号推送时间限制

ResultObject clearPushTimeLimit(id)

# 请求参数

名称	类型	描述	备注
id	String	手机号	-

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
MessageApi apiInstance = new MessageApi(token);
//实例化请求参数
String id = "id_example";

try {
    ResultObject result = apiInstance.clearPushTimeLimit(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用MessageApi.clearPushTimeLimit异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/message/clearPushTimeLimit
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"id":""
}

1
2
3

# 清除声光报警

ResultObject clearShengGuangAlarm()

# 请求参数

请求参数为空.

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化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();
}

1
2
3
4
5
6
7
8
9
10

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/message/clearAcoustoOpticAlarm
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{}

# 恢复默认声光报警为默认

ResultObject defaultMusicAcoustooptic(updateAcoustoOpticForm)

# 请求参数

名称	类型	描述	备注
updateAcoustoOpticForm	UpdateAcoustoOpticForm	updateAcoustoOpticForm

# UpdateAcoustoOpticForm

名称	类型	备注
authType	Integer	-
cumulativeCount	Integer	-
playCount	Integer	-
type	Integer	-

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
MessageApi apiInstance = new MessageApi(token);
//实例化请求参数
UpdateAcoustoOpticForm updateAcoustoOpticForm = new UpdateAcoustoOpticForm();

try {
    ResultObject result = apiInstance.defaultMusicAcoustooptic(updateAcoustoOpticForm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用MessageApi.defaultMusicAcoustooptic异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/message/defaultMusicAcoustooptic
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"playCount":0,
	"cumulativeCount":0,
	"authType":0,
	"type":0
}

1
2
3
4
5
6

# 清除当前用户所有报警分组

ResultObject deleteMessageGroup()

# 请求参数

请求参数为空.

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化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();
}

1
2
3
4
5
6
7
8
9
10

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/message/deleteMessageGroup
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{}

# 查询公司的声光报警声音路径

ResultAcoustooptic getAcoustoOptic()

# 请求参数

请求参数为空.

# 返回参数

ResultAcoustooptic

名称	类型	描述	备注
code	String	响应码	-
data	Acoustooptic	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

Acoustooptic

名称	类型	备注
authType	Integer	-
companyId	String	-
createdBy	String	-
createdTime	OffsetDateTime	-
cumulativeCount	Integer	-
id	String	-
path	String	-
playCount	Integer	-
subfix	String	-
type	Integer	-
updatedTime	OffsetDateTime	-
userId	String	-

# java-sdk 调用示例

//实例化api类，传入token
MessageApi apiInstance = new MessageApi(token);

try {
    ResultAcoustooptic result = apiInstance.getAcoustoOptic();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用MessageApi.getAcoustoOptic异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/message/getAcoustooptic
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{}

# 获取当前用户消息收藏分组

ResultMessageAlarmGroupVo getMessageGroupInfo()

# 请求参数

请求参数为空.

# 返回参数

ResultMessageAlarmGroupVo

名称	类型	描述	备注
code	String	响应码	-
data	MessageAlarmGroupVo	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

MessageAlarmGroupVo

名称	类型	描述	备注
alarmGroupData	List<MessageGroupVo>		-
messageGroupData	List<MessageGroupVo>		-

MessageGroupVo

名称	类型	描述	备注
flag	Boolean	标记	-
index	Integer	位置	-
status	Boolean	状态	-

MessageGroupVo

名称	类型	描述	备注
flag	Boolean	标记	-
index	Integer	位置	-
status	Boolean	状态	-

# java-sdk 调用示例

//实例化api类，传入token
MessageApi apiInstance = new MessageApi(token);

try {
    ResultMessageAlarmGroupVo result = apiInstance.getMessageGroupInfo();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用MessageApi.getMessageGroupInfo异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/message/getMessageGroupInfo
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{}

# 根据用户手机号查询手机号推送时间限制

ResultObject getPushTimeLimit()

# 请求参数

请求参数为空.

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
MessageApi apiInstance = new MessageApi(token);

try {
    ResultObject result = apiInstance.getPushTimeLimit();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用MessageApi.getPushTimeLimit异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/message/getPushTimeLimit
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{}

# 获取消息接收管理消息类型及推送方式

ResultListMessageRecevieVo getSystemMessageType()

# 请求参数

请求参数为空.

# 返回参数

ResultListMessageRecevieVo

名称	类型	描述	备注
code	String	响应码	-
data	List<MessageRecevieVo>	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

MessageRecevieVo

名称	类型	描述	备注
flag	Boolean	推送管理标识	-
i18nKey	String	当前消息类型多语言KEY	-
messageTypeId	String	消息类型id	-
name	String	消息类型名称	-
projectId	String	项目id	-
pushway	String	消息推送方式	-
regulationId	String	规则id	-
roleId	String	角色id	-
subject	String	消息主题	-
type	Integer	系统消息：0，自定义消息：1	-
userId	String	员工id	-

# java-sdk 调用示例

//实例化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();
}

1
2
3
4
5
6
7
8
9
10

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/message/getSystemMessageType
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{}

# 查询用户是否含有声光报警信息

ResultObject getacoustoopticMessage()

# 请求参数

请求参数为空.

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化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();
}

1
2
3
4
5
6
7
8
9
10

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/message/getAcoustoOpticMessage
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{}

# 根据用户手机号查询手机号推送时间限制

ResultObject saveOrUpdatePushTimeLimit(phonePushTimeForm)

# 请求参数

名称	类型	描述	备注
phonePushTimeForm	PhonePushTimeForm	phonePushTimeForm

# PhonePushTimeForm

名称	类型	描述	备注
alarmList	List<String>		-
id	String		-
name	String		-
sort	Integer		-
state	Integer		-
time	List<String>	时间	-
timeList	List<String>	位掩码记录周一到周日,例如:(0000000)	-
typeList	List<String>	添加推送类型	-

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
MessageApi apiInstance = new MessageApi(token);
//实例化请求参数
PhonePushTimeForm phonePushTimeForm = new PhonePushTimeForm();

try {
    ResultObject result = apiInstance.saveOrUpdatePushTimeLimit(phonePushTimeForm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用MessageApi.saveOrUpdatePushTimeLimit异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/message/saveOrUpdatePushTimeLimit
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"name":"",
	"id":"",
	"sort":0,
	"state":0
}

1
2
3
4
5
6

# 修改声光设置

ResultObject updateAcoustoOptic(updateAcoustoOpticForm)

# 请求参数

名称	类型	描述	备注
updateAcoustoOpticForm	UpdateAcoustoOpticForm	updateAcoustoOpticForm

# UpdateAcoustoOpticForm

名称	类型	备注
authType	Integer	-
cumulativeCount	Integer	-
playCount	Integer	-
type	Integer	-

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
MessageApi apiInstance = new MessageApi(token);
//实例化请求参数
UpdateAcoustoOpticForm updateAcoustoOpticForm = new UpdateAcoustoOpticForm();

try {
    ResultObject result = apiInstance.updateAcoustoOptic(updateAcoustoOpticForm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用MessageApi.updateAcoustoOptic异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/message/updateAcoustoOptic
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"playCount":0,
	"cumulativeCount":0,
	"authType":0,
	"type":0
}

1
2
3
4
5
6

# 更换声光报警的音频文件

ResultObject updateAcoustoopticFile()

# 请求参数

请求参数为空.

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化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();
}

1
2
3
4
5
6
7
8
9
10

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/message/updateAcoustoopticFile
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{}

# 修改当前用户选中的收藏分组

Result updateMessageGroup(flag, index, messageType)

# 请求参数

名称	类型	描述
flag	Boolean	是否选中
index	Integer	收藏分组下标
messageType	String	消息类型

# 返回参数

Result

名称	类型	备注
code	String	-
data	Object	-
msg	String	-
time	OffsetDateTime	-

# java-sdk 调用示例

//实例化api类，传入token
MessageApi apiInstance = new MessageApi(token);
//实例化请求参数
Boolean flag = true;
Integer index = 56;
String messageType = "messageType_example";

try {
    Result result = apiInstance.updateMessageGroup(flag, index, messageType);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用MessageApi.updateMessageGroup异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/message/updateMessageGroup
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"index":0,
	"messageType":""
}

1
2
3
4

← 消息推送综合示例→

消息中心服务

# 概述

# 清除声光报警和已读消息

# 请求参数

# ClearAcoustoOpticAndReadMessageForm

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 根据用户手机号查询手机号推送时间限制

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 清除声光报警

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 恢复默认声光报警为默认

# 请求参数

# UpdateAcoustoOpticForm

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 清除当前用户所有报警分组

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 查询公司的声光报警声音路径

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 获取当前用户消息收藏分组

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 根据用户手机号查询手机号推送时间限制

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 获取消息接收管理消息类型及推送方式

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# ** 查询用户是否含有声光报警信息**

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 根据用户手机号查询手机号推送时间限制

# 请求参数

# PhonePushTimeForm

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 修改声光设置

# 请求参数

# UpdateAcoustoOpticForm

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 更换声光报警的音频文件

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 修改当前用户选中的收藏分组

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 查询用户是否含有声光报警信息