消息推送

# 概述

消息推送

类名

MessagePushApi.java

成员方法

名称	方法	Method	Path
推送项目消息	sendMessageToProjectFollowedUser	POST	/api-organization/messagePush/sendMessageToProject
推送项目消息报警使用	sendMessageToProjectFollowedUserAlarm	POST	/api-organization/messagePush/sendMessageToProjectAlarm
推送消息到指定用户	sendMessageToSpecialUser	POST	/api-organization/messagePush/sendMessageToSpecialUser
推送消息到指定用户报警使用	sendMessageToSpecialUserAlarm	POST	/api-organization/messagePush/sendMessageToSpecialUserAlarm
发送短信	sendSmsMessage	POST	/api-organization/messagePush/sendSmsMessage
发送微信	sendWeChatMessage	POST	/api-organization/messagePush/sendWeChatMessage

# 推送项目消息

ResultObject sendMessageToProjectFollowedUser(param)

# 请求参数

名称	类型	描述	备注
param	ProjectServiceMessageParam	param

# ProjectServiceMessageParam

名称	类型	描述	备注
messageTypeId	String	消息类型id	-
params	Map<String, String>	消息详细参数	-
projectId	String	项目id	-

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
MessagePushApi apiInstance = new MessagePushApi(token);
//实例化请求参数
ProjectServiceMessageParam param = new ProjectServiceMessageParam();

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

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

# HTTP 调用示例

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

请求参数：

{
	"projectId":"",
	"messageTypeId":""
}

1
2
3
4

# 推送项目消息报警使用

ResultObject sendMessageToProjectFollowedUserAlarm(param)

# 请求参数

名称	类型	描述	备注
param	ProjectAlarmMessageParam	param

# ProjectAlarmMessageParam

名称	类型	描述	备注
messageGroup	Long	消息组	-
messageTypeId	String	消息类型id	-
params	Map<String, String>	消息详细参数	-
projectId	String	项目id	-

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
MessagePushApi apiInstance = new MessagePushApi(token);
//实例化请求参数
ProjectAlarmMessageParam param = new ProjectAlarmMessageParam();

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

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

# HTTP 调用示例

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

请求参数：

{
	"projectId":"",
	"messageTypeId":""
}

1
2
3
4

# 推送消息到指定用户

ResultObject sendMessageToSpecialUser(messageParam)

# 请求参数

名称	类型	描述	备注
messageParam	SpecifyServiceMessageParam	messageParam

# SpecifyServiceMessageParam

名称	类型	描述	备注
messageTypeId	String	消息类型id	-
params	Map<String, String>	消息详细参数	-
userIds	List<String>	用户id	-

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
MessagePushApi apiInstance = new MessagePushApi(token);
//实例化请求参数
SpecifyServiceMessageParam messageParam = new SpecifyServiceMessageParam();

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

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

# HTTP 调用示例

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

请求参数：

{
	"messageTypeId":""
}

1
2
3

# 推送消息到指定用户报警使用

ResultObject sendMessageToSpecialUserAlarm(param)

# 请求参数

名称	类型	描述	备注
param	SpecifyUserMessageParam	param

# SpecifyUserMessageParam

名称	类型	描述	备注
messageGroup	Long	消息组	-
messageTypeId	String	消息类型id	-
params	Map<String, String>	消息详细参数	-
projectId	String	项目id(可选)	-
userIds	List<String>	用户id	-

# 返回参数

ResultObject

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

# java-sdk 调用示例

//实例化api类，传入token
MessagePushApi apiInstance = new MessagePushApi(token);
//实例化请求参数
SpecifyUserMessageParam param = new SpecifyUserMessageParam();

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

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

# HTTP 调用示例

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

请求参数：

{
	"projectId":"",
	"messageTypeId":""
}

1
2
3
4

# 发送短信

ResultString sendSmsMessage(smsMessageParam)

# 请求参数

名称	类型	描述	备注
smsMessageParam	SmsMessageParam	smsMessageParam

# SmsMessageParam

名称	类型	描述	备注
action	String	短信推送服务	-
companyId	String	企业id	-
content	Map<String, String>	短信参数名称以及参数内容	-
phones	List<String>	手机号	-

# 返回参数

ResultString

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

# java-sdk 调用示例

//实例化api类，传入token
MessagePushApi apiInstance = new MessagePushApi(token);
//实例化请求参数
SmsMessageParam smsMessageParam = new SmsMessageParam();

try {
    ResultString result = apiInstance.sendSmsMessage(smsMessageParam);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用MessagePushApi.sendSmsMessage异常: " + e.getMessage());
    e.printStackTrace();
}

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

# HTTP 调用示例

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

请求参数：

{
	"action":"",
	"companyId":""
}

1
2
3
4

# 发送微信

ResultString sendWeChatMessage(param)

# 请求参数

名称	类型	描述	备注
param	WeChatMessageParam	param

# WeChatMessageParam

名称	类型	描述	备注
action	String	微信推送服务	-
companyId	String	企业id	-
content	Map<String, String>	微信参数名称以及参数内容	-
userIds	List<String>	用户id	-

# 返回参数

ResultString

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

# java-sdk 调用示例

//实例化api类，传入token
MessagePushApi apiInstance = new MessagePushApi(token);
//实例化请求参数
WeChatMessageParam param = new WeChatMessageParam();

try {
    ResultString result = apiInstance.sendWeChatMessage(param);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用MessagePushApi.sendWeChatMessage异常: " + e.getMessage());
    e.printStackTrace();
}

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

# HTTP 调用示例

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

请求参数：

{
	"action":"",
	"companyId":""
}

1
2
3
4

← 日志消息中心服务→