帮你快速理解、总结文档立即下载

HarmonyOS

最近更新时间:2026-08-04 16:32:53
我的收藏

前提条件

请确认已 开通 Push 服务 并完成 厂商配置,获取到了下列信息:
资源
获取位置
用途
SDKAppID
腾讯云控制台 > 即时通信 IM > 推送服务 Push > 概览
调用 registerPush。创建 Push 应用后,腾讯云控制台会自动创建相同 SDKAppID 的 Chat 应用。
Push Key
腾讯云控制台 > 即时通信 IM > 推送服务 Push > 概览 > 客户端密钥
独立 Push 场景下,作为 registerPushappKey 参数。
Chat Key
腾讯云控制台 > 即时通信 IM > 消息服务 Chat > 概览 > 密钥
Chat 登录使用。不要把 Chat Key 当作 registerPushappKey 传入。
Push 服务开通状态
腾讯云控制台 > 即时通信 IM > 推送服务 Push > 概览
创建 Push 应用不等于已开通 Push 服务,请确认 Push 服务已开通。
TIMPush iOS VERSION
VERSION 是 Podfile 中 TIMPush 依赖的版本号占位符,例如 8.9.75378.8.73578.7.7201 等,请以实际接入版本为准。
本文示例中的 VERSIONSDKAppIDappKey均为占位符,请勿在代码仓库中提交真实密钥。

操作步骤

步骤1:集成 TIMPush

集成 SDK:
// 版本号 “VERSION” 请前往 更新日志 中获取配置。
// oh-package.json5 中配置集成包
dependencies: {
"@tencentcloud/timpush": "^VERSION",
"@tencentcloud/imsdk": "^VERSION",
}

步骤2:注册推送

调用接口推送注册成功后,就可以收到离线推送通知了。
import { TIMPushListener, TIMPushManager, TIMPushMessage } from '@tencentcloud/timpush';

TIMPushManager.getInstance()
.registerPush(context, 您的 sdkAppId, "客户端密钥", IM 控制台证书 ID)
.then((result) => {
console.log("registerPush success:", result.message);
})
.catch((error: Error) => {
console.log("registerPush failed", error.code, error.message);
})

步骤3:消息触达统计配置

如果您需要统计触达数据,请按照如下完成配置:

回执地址:https://api.im.qcloud.com/v3/offline_push_report/harmony

步骤4:发送推送消息

您可以在 接入测试 指定 RegistrationID/userID 进行离线推送测试。REST API 接口详细说明可参见:全员/标签推送

步骤5:解析离线推送消息

收到推送消息后点击通知栏,组件会回调该点击事件和透传离线消息。
注意:
1. 注册回调时机必须放在应用 UIAbility 的 onCreate() 函数中。
2. 控制台配置点击后续动作按如下配置,选择打开应用内指定界面,请勿修改默认值。

let pushListener: TIMPushListener = {
onNotificationClicked: (data) => {
console.log("onNotificationClicked", data);
}
}

TIMPushManager.getInstance().addPushListener(pushListener);
恭喜您已经完成了推送插件的接入。如果接入完成收不到推送,请使用 排查工具 查看具体原因。