分发文档
快应用推送接入指南更新时间: 2024-09-26 10:36:00
一、简介
小米推送支持快应用接入推送服务,快应用的消息推送具有如下特点:
1. 应用注册成功后会给每个设备分配一个regId。
2. 通过小米服务器分配的appSecret进行发送消息。
- RegId消息:针对单用户发送
- 全量消息:针对所有用户
二、前端接入
详细介绍请参见:https://doc.quickapp.cn/features/service/push.html。
三、使用JAVA API推送
JAVA API的详细使用指南请参见《服务端Java SDK文档》。
消息发送
- RegId消息:针对单用户发送,调用sendHybridMessageByRegId接口。
- 全量消息:针对全量用户发送,调用broadcastHybridAll接口。
代码示例
public class ServerDemoForHybrid {
private static final String APP_SECRET = "应用的 AppSecret";
private static final String PACKAGE_NAME = "应用的包名";
private static final String REGID = "App注册后的分配的 regId";
private static final String HYBRID_PATH = "hybrid_pn";
public static void main(String[] args) throws Exception {
// 发送通知栏消息
testSendNotificationMessage();
}
/**
* 发送通知栏消息
*/
public static void testSendNotificationMessage() throws Exception {
List<String> list = new ArrayList<>();
list.add(REGID);
Sender sender = new Sender(APP_SECRET);
Message message = new Message.Builder()
.restrictedPackageName(PACKAGE_NAME)
.passThrough(0)
.notifyType(1) // 通知栏消息通知类型
.notifyId(11) // 通知栏消息的 notifyId,相同时消息内容会被替换
.title("Test regId message title sdk") // 通知栏消息的 title
.description("Test regId message desc12") // 通知栏消息的 desc
.extra(HYBRID_PATH, "/Detail?x=aaa&y=bbb") // 点击通知栏后打开应用页面 path,例:/Detail?xxx=111&yyy=222
.build();
Result result = sender.sendHybridMessageByRegId(message, list, 0);
System.out.println(result);
}
四、使用REST API推送
REST API的详细使用指南请参见《服务器API地址以及参数》。
参数说明
针对快应用推送,extra 中需要增加以下参数:
参数 | 取值 | 说明 |
extra.push_server_action | hybrid_message | 表示该消息为快应用消息。 |
extra.hybrid_pn | <页面Path> | 对于通知栏消息,需要打开指定页面是请设置该参数。 示例:/Detail?x=aaa&y=bbb |
消息发送
- RegId 消息:使用https://api.xmpush.xiaomi.com/v2/message/regid。
- 全量消息:使用https://api.xmpush.xiaomi.com/v2/message/topic,需要指定topic=<应用包名>。
上一篇:
下一篇:
文档内容是否有帮助?