集成小米推送
按照本指南集成小米 Mi Push 国内版 或海外版 ,让融云 SDK 支持小米推送。
在集成第三方推送前,请确保已在融云控制台配置 Android 应用 ID。详见推送集成概述。
IMLib SDK 从 5.6.8 开始支持小米海外推送服务。
在融云控制台配置小米推送
如果想通过小米推送通道从融云服务端接收推送通知,您需要在融云控制台上提供您的小米推送应用的详细信息。
- 前往小米开放平台,选择您当前的项目所对应的小米应用,点击应用信息,并记录下应用的 AppID、AppKey、AppSecret。
如果没有小米开发者账号,或尚未创建应用,参考小米推送文档:
- 中国大陆地区 - 推送服务启用指南
- 海外版 - Push Service Activation Guide 。目前,小米在印度孟买、德国法兰克福、俄罗斯莫斯科和新加坡设有数据中心,请选择合适的地域创建应用。
其中 AppSecret 是小米推送服务器端的身份标识,在使用小米推送服务端 SDK 向客户端发送消息时使用,需要在融云控制台的小米推送配置中提供给融云。AppId 和 AppKey 是小米推送客户端的身份标识,后续在启用小米推送服务时需要提供给融云 SDK,用于初始化小米推送客户端 SDK。
-
打开融云控制台,前 往在应用标识页面。点击设置推送,找到 Android > 小米推送,填入上一步获取的 AppSecret。
-
(可选)配置小米推送通知标题。设置默认的推送通知标题。一般情况下客户端发送消息转 Push 时不使用此标题设置。在调用融云服务端 API
/push.json
、/push/user.json
、/push/custom.json
接口推送通知时,如未传入通知标题,则使用该处设置的标题。从服务端发消息时,如果发送用户 ID 在融云服务端没有用户名,也会使用此 “推送通知标题”。 -
选择推送通道类型。小米推送的消息类型,分为普通消息和通知消息,查看小米推送消息限制明文档。
- 普通消息,融云默认使用的小米推送通道,有限制。
- 通知消息,无限制。需要填写小米后台申请的 channelId。
-
保存设置。所有设置 15 分钟后生效。
您已完成需要融云控制台小米推送配置的全部内容。现在可以设置客户端集成。
配置客户端接收小米推送
-
首先,需要将小米推送客户端 SDK 添加到您的 Android 项目。您需要手动下载小米推送客户端 SDK 并加到项目中。
-
融云官网 SDK 下载页提供小米推送客户端 SDK 下载。在页面勾选第三方推送后,下载 zip 文件。在解压后的文件目录中找到 pushlibs 下的小米推送客户端 SDK 文件(
MiPush_SDK_Client_xxx.jar
,4.9.1)。拷贝 .jar 文件到 app 的libs
目录下。 -
如需获取最新版小米推送客户端 SDK,可以从小米直接获取。MiPush Android 客户端 SDK 从 5.0.1 版本开始,提供 AAR 包接入方式。
- 参考小米文档 Android 客户端 SDK 集成指南(JAR版)
- 参考小米文档 Android 客户端 SDK 集成指南(AAR版)(中国大陆)
- 参考小米文档 Android 客户端 SDK 集成指南(AAR版)(非中国大陆)
-
- 如果您项目使用的 IMLib/IMKit SDK 版本大于等于 5.2.1,必须使用小米推送客户端 SDK 4.9.1 及以上版本。
- 由于 Android 12 通知 trampoline 限制,对于 targetSdkVersion ≥ 31 的应用,需要接入SDK 4.9.1及以上版本,否则会出现点击通知无法正常跳转的情况。
- 小米推送客户端 SDK 区分中国大陆地区与海外地区,请从对应小米官方文档中下载正确的版本。
-
在 App 的
build.gradle
中添加依赖:-
如果集成 jar 文件:
Groovydependencies {
implementation files('libs/MiPush_SDK_Client_xxx.jar')
}
-