跳到主要内容

发送通知消息

场景介绍

通知消息通过Push Kit通道直接下发,可在终端设备的通知中心、锁屏、横幅等展示,用户点击后拉起应用。您可以通过设置通知消息样式来吸引用户。

约束与限制

发送通知消息能力支持Phone、Tablet、PC/2in1设备。并且从5.1.0(18)版本开始,新增支持Wearable设备;从5.1.1(19)版本开始,新增支持TV设备。

开通权益

Push Kit根据消息内容,将通知消息分类为服务与通讯资讯营销两大类别,开放通知消息自分类权益。

两种类型的通知消息在提醒方式、消息展示位置、推送数量上皆存在差异。更多说明与权益申请详情参见申请通知消息自分类权益

  • 若您未申请通知消息自分类权益,则推送的通知消息默认为资讯营销类(category取值为MARKETING)消息;若您仅需发送资讯营销类消息,则无需申请通知消息自分类权益。
  • 资讯营销类消息每天可发送消息数量根据应用类型分为2条5条,详情请参见通知消息推送数量管理规则。若您发送通知消息被频控,请尝试发送测试消息或申请自分类权益,详情请参见消息频控

频控规则

调测阶段,每个项目每日全网最多可推送1000条测试消息。发送测试消息需设置testMessage为true。

正式发布阶段,单设备单应用下每日推送消息总条数受设备消息频控限制,系统会根据现网使用场景和流量进行管控,不合理的使用场景系统会进行频控。

服务通讯类消息与资讯营销类消息存在不同的频控策略,详情请参见通知消息推送数量管理规则

开发步骤

  1. 参见指导获取Push Token

  2. 为确保应用可正常收到消息,应用发送通知前需调用requestEnableNotification()方法弹出提醒,告知用户需要允许接收通知消息。示例代码如下:

    // 文件路径: src/main/ets/entryability/EntryAbility.ets
    import { BusinessError } from '@kit.BasicServicesKit';
    import { UIAbility } from '@kit.AbilityKit';
    import { window } from '@kit.ArkUI';
    import { hilog } from '@kit.PerformanceAnalysisKit';
    import { notificationManager } from '@kit.NotificationKit';

    export default class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage: window.WindowStage) {
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageCreate');
    windowStage.loadContent('pages/Index', (err, data) => {
    if (err.code) {
    hilog.error(0x0000, 'testTag', 'Failed to load the content. Cause: %{public}s', JSON.stringify(err) ?? '');
    return;
    }
    hilog.info(0x0000, 'testTag', 'Succeeded in loading the content. Data: %{public}s', JSON.stringify(data) ?? '');
    notificationManager.requestEnableNotification(this.context).then(() => {
    hilog.info(0x0000, 'testTag', `[ANS] requestEnableNotification success`);
    }).catch((err: BusinessError) => {
    hilog.error(0x0000, 'testTag', `[ANS] requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
    });
    });
    }
    }
  3. 为确保点击消息可以正常跳转应用页面,在应用项目中完成skills标签配置,详情请参见点击消息动作

  4. 应用服务端调用Push Kit服务端的REST API推送通知消息。若未开通权益,或开通的权益类型与调用REST API推送场景化消息时,请求体中携带的category字段值不一致,消息将会默认归为资讯营销类消息,则会受到“单个应用每日每设备推送数量为2条或5条”的频控限制。

    • 本示例仅包含REST API中部分消息字段,关于服务端开发的更多详情请参见端云调试

    • 请使用V3版本的请求URL(https://push-api.cloud.huawei.com/v3/[projectId]/messages:send)进行消息推送

      请求URL版本为V3(https://push-api.cloud.huawei.com/v3/[projectId]/messages:send)时,仅支持给HarmonyOS Next/5.x及之后的系统版本推送通知;版本为V2(https://push-api.cloud.huawei.com/v2/[projectId]/messages:send)时,仅支持给HarmonyOS 3.x/4.x的系统版本推送通知。

    请求示例如下(注意category参数设置为实际消息类型):

    // Request URL
    POST "https://push-api.cloud.huawei.com/v3/[projectId]/messages:send"

    // Request Header
    Content-Type: application/json
    Authorization: Bearer eyJr*****OiIx---****.eyJh*****iJodHR--***.QRod*****4Gp---****
    push-type: 0

    // Request Body
    {
    "payload": {
    "notification": {
    "category": "xxxxxx",// 替换为实际消息类型
    "title": "普通通知标题",
    "body": "普通通知内容",
    "clickAction": {
    "actionType": 0
    },
    // 通知是否在应用在前台情况下展示,仅对push-type为0的通知消息生效
    "foregroundShow": true,
    "notifyId": 12345
    }
    },
    "target": {
    "token": ["MAMzLg**********lPW"]
    },
    "pushOptions": {
    "testMessage": true,
    "ttl": 86400
    }
    }
    • [projectId]:项目ID,登录AppGallery Connect网站,选择“开发与服务”,在项目列表中选择对应的项目,左侧导航栏选择“项目设置”,在该页面获取。
    • Authorization:JWT格式字符串,可参见Authorization获取。
    • push-type:0表示Alert消息,此处为通知消息场景。
    • category:表示通知消息自分类的类别,MARKETING为资讯营销类消息,更多类别可参见category获取。
    • actionType:0表示点击消息进入应用首页,1表示点击消息后进入应用内页
    • token:Push Token,可参见获取Push Token获取。
    • testMessage:(选填)测试消息标识,true表示测试消息。每个项目每天限制发送1000条测试消息,单次推送可发送Token数不超过10个。详情请参见testMessage
    • ttl:(选填)消息缓存时间,详见ttl
    • notifyId:(选填)自定义消息标识字段。不携带或者设置-1时,推送服务自动为每条消息生成一个唯一标识;不同的通知消息可以拥有相同的notifyId,实现新消息覆盖旧消息功能。仅支持数字,范围 [0, 2147483647],若要用于消息撤回则必填。详情请参见notifyId
    • foregroundShow:(选填)通知消息是否在应用在前台时候展示。true表示应用在前后台都展示。false表示应用只在后台展示,应用在前台时,通知栏消息将不会展示。默认为true。foregroundShow为true时,receiveMessage不会被触发,无法获取消息数据。
  5. 发送消息推送请求,请求响应请参见响应参数。请求发送成功后,可检查设备是否收到通知消息,如果设备未收到通知消息,请参见常见问题进行排查。

点击消息动作

点击消息进入应用首页

  1. 检查项目模块级别下的src/main/module.json5中的skills标签配置,其中用于标识应用首页的skill(即配置了"entity.system.home"和"ohos.want.action.home"的skill)中不要配置uris,否则消息会接收不到

    module.json5文件中的skills标签下可以同时存在多个skill对象,每个对象对应一种能力。

    若您需要同时设置推送消息跳转能力和其他跳转能力(如NFC跳转、浏览器跳转等),需要在skills数组中创建不同的skill对象,分别映射对应的能力。

    点击消息进入应用首页skills标签配置示例:

    {
    "module": {
    // ...
    "abilities": [
    {
    "name": "TestAbility",
    "srcEntry": "./ets/abilities/TestAbility.ets",
    "exported": false,
    "startWindowIcon": "$media:startIcon",
    "startWindowBackground": "$color:start_window_background",
    "skills": [
    // 该skill标识应用首页,不要配置uris
    {
    "entities": [
    "entity.system.home"
    ],
    "actions": [
    // "action.system.home"为API19以下版本配置,已废弃
    "ohos.want.action.home"
    ]
    },
    // 其他skill配置
    {}
    ]
    }
    ]
    }
    }
  2. 发送消息时设置actionType字段为0。

    // Request URL
    POST "https://push-api.cloud.huawei.com/v3/[projectId]/messages:send"

    // Request Header
    Content-Type: application/json
    Authorization: Bearer eyJr*****OiIx---****.eyJh*****iJodHR--***.QRod*****4Gp---****
    push-type: 0

    // Request Body
    {
    "payload": {
    "notification": {
    "category": "MARKETING",
    "title": "普通通知标题",
    "body": "普通通知内容",
    "clickAction": {
    "actionType": 0,
    "data": {"testKey": "testValue"}
    }
    }
    },
    "target": {
    "token": ["MAMzLg**********lPW"]
    },
    "pushOptions": {
    "testMessage": true
    }
    }
    • actionType:点击消息的动作,0表示点击消息后进入首页(即入口Ability当前所在页面,入口Ability通常为EntryAbility)。

      场景化消息请求体中,接口URL版本为V3(https://push-api.cloud.huawei.com/v3/[projectId]/messages:send)时,仅支持给HarmonyOS Next/5.x及之后的系统版本推送通知;接口URL版本为V2(https://push-api.cloud.huawei.com/v2/[projectId]/messages:send)时,仅支持给HarmonyOS 3.x/4.x的系统版本推送通知。

点击消息进入应用内页

  1. 在您的项目模块级别下的src/main/module.json5 中设置目标Ability中skills标签的actions或uris值,两种方式如下:

    方式一:在skills标签中新增一个独立的skill对象,配置actions参数用于点击消息进入应用内页,示例如下:

    {
    "name": "TestAbility",
    "srcEntry": "./ets/abilities/TestAbility.ets",
    "exported": false,
    "startWindowIcon": "$media:startIcon",
    "startWindowBackground": "$color:start_window_background",
    "skills": [
    // 保持现有skill对象不变
    {
    "actions": [
    "com.app.action"
    ]
    },
    // 新增一个独立的skill对象,配置actions参数
    {
    "actions": [
    "com.test.action"
    ]
    }
    ]
    }

    方式二:在skills标签中新增一个独立的skill对象,配置uris参数用于点击消息进入应用内页(必须同时配置actions参数和uris参数,actions参数为空),示例如下:

    {
    "name": "TestAbility",
    "srcEntry": "./ets/abilities/TestAbility.ets",
    "exported": false,
    "startWindowIcon": "$media:startIcon",
    "startWindowBackground": "$color:start_window_background",
    "skills": [
    // 保持现有skill对象不变
    {
    "actions": [
    "com.app.action"
    ]
    },
    // 新增一个独立的skill对象,配置uris参数,且必须同时配置actions参数,actions参数为空字符串
    {
    "actions": [""],
    "uris": [
    {
    "scheme": "https",
    "host": "www.xxx.com",
    "port": "8080",
    "path": "push/test"
    }
    ]
    }
    ]
    }

    module.json5文件中的skills标签下可以同时存在多个skill对象,每个对象对应一种能力。

    若您需要同时设置推送消息跳转能力和其他跳转能力(如NFC跳转、浏览器跳转等),需要在skills数组中创建不同的skill对象,分别映射对应的能力。

  2. 发送消息时clickAction中设置actionType字段为1。

    // Request URL
    POST "https://push-api.cloud.huawei.com/v3/[projectId]/messages:send"

    // Request Header
    Content-Type: application/json
    Authorization: Bearer eyJr*****OiIx---****.eyJh*****iJodHR--***.QRod*****4Gp---****
    push-type: 0

    // Request Body
    {
    "payload": {
    "notification": {
    "category": "MARKETING",
    "title": "普通通知标题",
    "body": "普通通知内容",
    "clickAction": {
    "actionType": 1,
    "action": "com.test.action",
    "uri": "https://www.xxx.com:8080/push/test",
    "data": {"testKey": "testValue"}
    }
    }
    },
    "target": {
    "token": ["MAMzLg**********lPW"]
    },
    "pushOptions": {
    "testMessage": true
    }
    }
    • actionType:点击消息动作,1表示点击消息后进入应用内页。当本字段设置为1时,uri和action至少填写一个,若都填写优先寻找与action匹配的应用页面。若action和uri都未匹配到应用页面,则点击消息后会进入应用首页。
    • action:表示能够接收Want的action值的集合,取值可以自定义。
    • uri:表示与Want中uris相匹配的集合,uris规则请参见skills标签

    • 场景化消息请求体中,接口URL版本为V3(https://push-api.cloud.huawei.com/v3/[projectId]/messages:send)时,仅支持给HarmonyOS Next/5.x及之后的系统版本推送通知;接口URL版本为V2(https://push-api.cloud.huawei.com/v2/[projectId]/messages:send)时,仅支持给HarmonyOS 3.x/4.x的系统版本推送通知。
    • 若action和uri都未匹配成功,则点击消息后会进入应用首页。

数据传递

应用服务端调用Push Kit服务端的REST API推送通知消息时,可携带data字段,当用户点击消息时将传递数据至客户端应用。

  1. 调用REST API推送通知消息,消息体中clickAction携带data字段。

    {
    "payload": {
    "notification": {
    "category": "MARKETING",
    "title": "普通通知标题",
    "body": "普通通知内容",
    "clickAction": {
    "actionType": 0,
    "data": {"testKey": "testValue"} // 携带data字段
    }
    }
    },
    "target": {
    "token": ["MAMzLg**********lPW"]
    },
    "pushOptions": {
    "testMessage": true
    }
    }

    data:点击消息时携带的JSON格式的数据。

  2. 在待跳转页面(以TestAbility为例)中的onCreate()方法中覆盖重写如下代码(冷启动时进入该生命周期回调):

    // 文件路径: src/main/ets/abilities/TestAbility.ets
    import { UIAbility, Want } from '@kit.AbilityKit';
    import { hilog } from '@kit.PerformanceAnalysisKit';

    export default class TestAbility extends UIAbility {
    onCreate(want: Want): void {
    // 获取消息中传递的data数据
    const data = want.parameters;
    const value = want.parameters?.["testKey"]; // value: "testValue"
    hilog.info(0x0000, 'testTag', 'Succeeded in getting message data, value is %{public}s', value);
    // 根据实际业务场景对data进行处理
    }
    }

    onNewWant()方法中覆盖重写如下代码(热启动时进入该生命周期回调):

    // 文件路径: src/main/ets/abilities/TestAbility.ets
    import { UIAbility, Want } from '@kit.AbilityKit';
    import { hilog } from '@kit.PerformanceAnalysisKit';

    export default class TestAbility extends UIAbility {
    onNewWant(want: Want): void {
    // 获取消息中传递的data数据
    const data = want.parameters;
    const value = want.parameters?.["testKey"]; // value: "testValue"
    hilog.info(0x0000, 'testTag', 'Succeeded in getting message data, value is %{public}s', value);
    // 根据实际业务场景对data进行处理
    }
    }

onNewWant()方法仅在单例(singleton)模式下可用。

设置通知消息样式

Push Kit提供了多种通知消息样式,您可以自定义其中内容来吸引用户,从而提高应用的日活跃用户数量。

普通通知

您在发送通知消息时notification参数中必须携带titlebody字段,来设置应用收到通知消息后展示在通知中心的标题与内容。文本内容最多显示3行,超出3行以“...”截断。

消息体示例:

{
"payload": {
"notification": {
"category": "MARKETING",
"title": "推送服务",
"body": "推送服务(Push Kit)是华为提供的消息推送平台,建立了从云端到终端的消息推送通道。您通过集成推送服务,可以向客户端应用实时推送消息,构筑良好的用户关系,提升用户的感知度和活跃度。",
"clickAction": {
"actionType": 0
}
}
},
"target": {
"token": ["MAMzLg**********lPW"]
},
"pushOptions": {
"testMessage": true
}
}

通知角标

Wearable、TV不支持此通知样式。

您可以发送通知消息时携带badge字段来设置应用收到通知消息后以数字的形式展示角标,提醒用户查看消息。

消息体示例:

{
"payload": {
"notification": {
"category": "MARKETING",
"title": "通知标题",
"body": "通知内容",
"badge":{
"addNum": 1,
"setNum": 99
},
"clickAction": {
"actionType": 0
}
}
},
"target": {
"token": ["MAMzLg**********lPW"]
},
"pushOptions": {
"testMessage": true
}
}

  • addNum设置后为应用角标累加数字,非应用角标实际显示数字。
  • setNum设置后为应用角标实际显示数字。setNum优先级高于addNum。
  • 打开应用或者点击、清理通知消息并不会清理角标数字,开发者可通过setBadgeNumber()方法清理角标,使用前需先导入模块
  • 当setBadgeNumber()方法中的badgeNumber设置为0时,可以实现清理效果。

通知大图标

Wearable不支持此通知样式。

推送服务禁止推送包含敏感信息的图片。

您可以发送通知消息时携带image字段设置消息大图标内容,提醒用户查看消息。

消息体示例:

{
"payload": {
"notification": {
"category": "MARKETING",
"title": "推送服务",
"body": "推送服务是华为提供的消息推送平台",
"image": "https://***.png", // 支持图片的格式为PNG、JPG、JPEG、BMP、WEBP,图片像素的总字节数不超过192KB,若超过则图片不展示。
"clickAction": {
"actionType": 0
}
}
},
"target": {
"token": ["MAMzLg**********lPW"]
},
"pushOptions": {
"testMessage": true
}
}

多行文本样式

Wearable不支持此通知样式。

您可以发送通知消息时在notification中携带inboxContentstyle字段设置通知消息为多行文本样式。最多可展示3行内容,每行内容无法完全展示时以“...”截断。

消息体示例:

{
"payload": {
"notification": {
"category": "MARKETING",
"title": "推送个性化显示",
"body": "通知内容",
"style": 3,
"inboxContent": [
"1. 通知栏消息样式",
"2. 通知栏消息提醒方式和展示方式",
"3. 通知栏消息语言本地化"
],
"clickAction": {
"actionType": 0
}
}
},
"target": {
"token": ["MAMzLg**********lPW"]
},
"pushOptions": {
"testMessage": true
}
}

  • 多行文本样式需要设置style字段为3。
  • 当您发送多条通知消息导致用户通知消息折叠时,多行文本样式在展开前显示的标题与内容取自title与body字段。
  • 当用户展开多行文本消息,或仅存在一条多行文本消息时,通知中显示的标题与内容取自title与inboxContent字段。

开发通知消息账号校验

Push Kit提供了账号校验功能,该功能支持您根据终端设备上不同账户属性来推送消息,将通知发送给对应设备上的对应账号。

举例:华为手机上某个应用存在账号A和账号B,若当前登录的账号A切换至账号B后,发送给账号A的通知消息在到达设备后不会进行展示,以避免账号B看到账号A的消息。

  • 当Push Token变更后,账号与应用的绑定关系自动解除。
  • 绑定的应用内账号数量最大为10。

Push Kit支持华为账号和应用账号两种账号类型:

  • 华为账号

    该profileId为应用通过华为账号映射的唯一匿名标识。

    调用bindAppProfileId()绑定接口时机:

    • 在应用内通过华为账号授权登录后。
    • 在应用内从其他账号切换到当前华为账号后。

    调用unbindAppProfileId()解绑接口时机:

    • 在应用内登出华为账号后。

    举例: 用户选择华为账号作为应用登录账号并登录账号A成功后,调用Push Kit绑定接口bindAppProfileId()将账号A的profileId绑定到当前设备的应用token上。应用服务器发送通知消息时若携带该账号A的profileId,则只有当前登录的华为账号为账号A时,才会展示通知消息;若不携带profileId,则无论当前登录的华为账号是否为账号A,都正常展示通知消息。

  • 应用账号

    该profileId为应用通过自己的账号映射的唯一匿名标识。

    调用bindAppProfileId()绑定接口时机:

    • 在应用内登录应用账号后。
    • 在应用内从其他应用账号切换到当前应用账号后。

    调用unbindAppProfileId()解绑接口时机:

    • 在应用内登出应用账号后。

    举例: 用户成功登录应用的账号A后,调用Push Kit绑定接口bindAppProfileId()将账号A的profileId绑定到当前设备的应用token上。应用服务器发送通知消息时若携带账号A的profileId,则只有当前登录的应用账号为账号A时,才会展示通知消息;若不携带profileId,则无论当前登录的应用账号是否为账号A,都正常展示通知消息。

若在账号登出时未做unbindAppProfileId()解绑,或者在账号切换时未做bindAppProfileId()重新绑定,则会导致应用依然能接收到原账号的通知消息。

  1. 参见指导获取Push Token

  2. 为确保应用可正常收到通知消息,建议应用发送通知前调用requestEnableNotification()方法弹出提醒,告知用户需要允许接收通知消息。详情请参见Notification Kit-请求通知授权

  3. 为待绑定的账号生成一个非空唯一的profileId(不建议使用真实的账号id,推荐使用账号id自行生成对应的匿名标识,能与该账号id建立唯一映射关系即可,生成算法无限制),调用bindAppProfileId()方法,添加当前设备上该用户与应用的关系,代码示例:

    import { hilog } from '@kit.PerformanceAnalysisKit';
    import { pushCommon, pushService } from '@kit.PushKit';
    import { BusinessError } from '@kit.BasicServicesKit';

    // 定义需要绑定的profileId,建议使用账号id对应的匿名标识
    const profileId: string = '111***222';
    // 绑定应用账号
    pushService.bindAppProfileId(pushCommon.AppProfileType.PROFILE_TYPE_APPLICATION_ACCOUNT, profileId).then(() => {
    hilog.info(0x0000, 'testTag', 'Succeeded in binding app profile id');
    }).catch((err: BusinessError) => {
    hilog.error(0x0000, 'testTag', 'Failed to bind app profile id: %{public}d %{public}s', err.code, err.message);
    });
  4. 建议您将Push Token和生成的profileId上报到应用服务端,便于应用服务端向终端推送消息。

  5. 应用服务端调用REST API推送通知消息,通知消息示例如下:

    // Request URL
    POST "https://push-api.cloud.huawei.com/v3/[projectId]/messages:send"

    // Request Header
    Content-Type: application/json
    Authorization: Bearer eyJr*****OiIx---****.eyJh*****iJodHR--***.QRod*****4Gp---****
    push-type: 0

    // Request Body
    {
    "payload": {
    "notification": {
    "category": "MARKETING",
    "title": "普通通知标题",
    "body": "普通通知内容",
    "profileId": "111***222",
    "clickAction": {
    "actionType": 0
    }
    }
    },
    "target": {
    "token": ["MAMzLg**********lPW"]
    },
    "pushOptions": {
    "testMessage": true
    }
    }
    • [projectId]:项目ID,登录AppGallery Connect网站,选择“开发与服务”,在项目列表中选择对应的项目,左侧导航栏选择“项目设置”,在该页面获取。
    • Authorization:JWT格式字符串,可参见Authorization获取。
    • push-type:0表示通知消息场景。
    • actionType:0表示点击消息打开应用首页。
    • token:Push Token,可参见获取Push Token获取。
    • profileId:应用内账号id匿名标识。详情请参见profileId

    消息发送成功后,Push Kit会先校验绑定账号时的AppProfileType(华为账号或应用账号):

    • 若绑定华为账号则先校验下发消息中携带的profileId和之前应用绑定的profileId是否一致,再校验当前登录的华为账号和绑定时登录的分布式账号是否一致,若全部满足则展示消息,否则不展示消息。

    • 若绑定应用账号则校验下发消息中携带的profileId和之前应用绑定的profileId是否一致,若满足则展示消息,否则不展示消息。

      场景化消息请求体中,接口URL版本为V3(https://push-api.cloud.huawei.com/v3/[projectId]/messages:send)时,仅支持给HarmonyOS Next/5.x及之后的系统版本推送通知;接口URL版本为V2(https://push-api.cloud.huawei.com/v2/[projectId]/messages:send)时,仅支持给HarmonyOS 3.x/4.x的系统版本推送通知。

应用在前台时处理通知消息

为实现应用在后台时展示通知消息,在前台时只接收通知消息并自行完成业务处理,需要服务端和客户端协同配置,具体步骤可以参考以下:

  1. 服务端调用REST API推送通知消息,消息体中携带foregroundShow字段,并且设置为false(默认为true,表示前后台都展示) ,则应用在前台时不会展示通知消息。

    {
    "payload": {
    "notification": {
    "category": "MARKETING",
    "title": "普通通知标题",
    "body": "普通通知内容",
    "clickAction": {
    "actionType": 0
    },
    "foregroundShow": false // 设置为false则应用在前台时不会展示通知消息
    }
    },
    "target": {
    "token": ["MAMzLg**********lPW"]
    },
    "pushOptions": {
    "testMessage": true
    }
    }
  2. 在客户端项目模块的src/main/module.json5文件的对应Ability配置中(以PushMessageAbility为例),skills标签的actions属性内容配置为action.ohos.push.listener项目中有且只能有一个ability定义该action)。

    {
    "name": "PushMessageAbility",
    "srcEntry": "./ets/abilities/PushMessageAbility.ets",
    "launchType": "singleton",
    "startWindowIcon": "$media:startIcon",
    "startWindowBackground": "$color:start_window_background",
    "exported": false,
    "skills": [
    // 保持现有skill对象不变
    {
    "actions": [
    "com.app.action"
    ]
    },
    // 新增一个独立的skill对象,配置actions参数
    {
    "actions": [
    "action.ohos.push.listener"
    ]
    }
    ]
    }
  3. 在客户端项目中,已经通过步骤2配置了actions属性内容的UIAbility类的onCreate()中(以PushMessageAbility为例),通过receiveMessage()方法传入PushType为"DEFAULT"获取通知消息,用于应用在前台时接收通知消息,示例代码如下:

    // 文件路径: src/main/ets/abilities/PushMessageAbility.ets
    import { UIAbility } from '@kit.AbilityKit';
    import { pushService } from '@kit.PushKit';
    import { BusinessError } from '@kit.BasicServicesKit';
    import { hilog } from '@kit.PerformanceAnalysisKit';

    /**
    * 此处以PushMessageAbility为例,用于应用在前台时接收通知消息
    */
    export default class PushMessageAbility extends UIAbility {
    onCreate(): void {
    try {
    // receiveMessage中的参数固定为DEFAULT
    pushService.receiveMessage('DEFAULT', this, (payload) => {
    try {
    // 获取服务端传递的数据
    const data: string = payload.data;
    // TODO:业务自行处理
    hilog.info(0x0000, 'testTag', 'Succeeded in getting notification,data=%{public}s',
    JSON.stringify(JSON.parse(data)?.notification));
    } catch (e) {
    let errRes: BusinessError = e as BusinessError;
    hilog.error(0x0000, 'testTag', 'Failed to process data: %{public}d %{public}s',
    errRes.code, errRes.message);
    }
    });
    } catch (err) {
    let e: BusinessError = err as BusinessError;
    hilog.error(0x0000, 'testTag', 'Failed to get message: %{public}d %{public}s', e.code,
    e.message);
    }
    }
    }

通知消息自定义铃声实现

当用户终端收到通知消息时,通知提示会播放系统默认通知铃声。如需实现自定义铃声功能(category取值为MARKETING不支持该功能),消息需要携带sound字段。此功能需要服务端和客户端协同配置,具体步骤可以参考以下:

  1. 将自定义铃声文件放在客户端工程中/resources/rawfile路径下(例如设置为alert.mp3,对应本地的 /resources/rawfile/alert.mp3文件),重新编译安装应用程序包。

  2. 服务端调用REST API推送通知消息,消息体中携带sound字段。

    // Request URL
    POST "https://push-api.cloud.huawei.com/v3/[projectId]/messages:send"

    // Request Header
    Content-Type: application/json
    Authorization: Bearer eyJr*****OiIx---****.eyJh*****iJodHR--***.QRod*****4Gp---****
    push-type: 0

    // Request Body
    {
    "payload": {
    "notification": {
    "category": "TRAVEL", // 替换为实际消息类型
    "title": "普通通知标题",
    "body": "普通通知内容",
    "clickAction": {
    "actionType": 0
    },
    "notifyId": 12345,
    "sound": "alert.mp3", // category取值为MARKETING时,不支持该功能
    "soundDuration": 10 // 请求同时携带sound字段时才会生效
    }
    },
    "target": {
    "token": ["MAMzLg**********lPW"]
    },
    "pushOptions": {
    "testMessage": true,
    "ttl": 86400
    }
    }
    • sound:(选填)自定义消息通知铃声。此处设置的铃声文件必须放在应用的/resources/rawfile路径下。例如设置为alert.mp3,对应应用本地的 /resources/rawfile/alert.mp3文件。详情请见sound。category取值为MARKETING时,不支持该功能。
    • soundDuration:(选填)自定义消息通知铃声时长,仅支持数字,单位为秒,取值范围 [1, 60],在请求同时携带sound字段时才会生效。sound字段传入的自定义消息通知铃声会播放至soundDuration字段值后停止,若自定义消息通知铃声对应的时长不足soundDuration字段值则会循环播放,在达到soundDuration字段值后停止。详情请参见soundDuration