推送基于账号的订阅消息

场景介绍

当用户授权同意订阅消息模板后，元服务的服务端主动调用服务通知REST API接口，向登录了账号的设备发送订阅消息（服务通知消息）。

频控规则

若订阅模板类型为“一次性订阅”，推送消息数量受控于元服务发起订阅请求并获得用户授权的次数。每次发送订阅消息都需要获取用户授权。

若订阅模板类型为“长期订阅”，推送消息数量将在服务通知的模板详情页说明，元服务可在模板限制的订阅周期及频次内多次下发通知，详情见选用订阅模板。

开发指导

推送订阅消息的消息示例如下，更多详情请见服务通知。

// Request URL
POST https://push-api.cloud.huawei.com/v1/[projectId]/service_notification/send
 
// Request Header
Authorization: Bearer eyJr*****OiIx---****.eyJh*****iJodHR--***.QRod*****4Gp---****

// Request Body
{
  "msgId": "20240514ABCDE",
  "appId": "6**********972",
  "toOpenId": "A**********O",
  "templateId": "1**********2",
  "templateParams": {
    "thing_0": "待取号",
    "time_1": "2024年5月30日 13:00~2024年5月30日 14:00",
    "thing_2": "XX银行XX支行"
  }
}

• [projectId]：项目ID，登录AppGallery Connect网站，选择“我的项目”，在项目列表中选择对应的项目，左侧导航栏选择“项目设置”，在该页面获取。
• Authorization：JWT格式字符串，可参见Authorization获取。
• msgId：消息id，唯一确定一条消息，由元服务自行设置。
• appId：元服务的APP ID，登录AppGallery Connect网站，选择“我的元服务”，在HarmonyOS页签下点击对应元服务，左侧导航栏选择“信息中心”，在该页面获取。
• toOpenId：接收者（用户）账号登录的 openID。使用从端侧上报的openID，或请求华为账号服务器获取用户信息。
• templateId：订阅消息对应的模板ID，与发起订阅请求时用户授权订阅的entityId相同，详情见开发指导。
• templateParams：订阅消息模板中的占位符需要被替换的变量值。

  以“取号提醒”模板为例：

  

  templateParams中的参数项为元服务选用的模板中的配置参数。具体可配置项请见选用订阅模板。

  注意

  填写templateParams时，请确保填入元服务选用模板的所有已勾选模板参数。

点击消息动作

点击消息进入应用首页并传递数据

消息示例如下，更多详情请见服务通知。

1. 发送消息时，在clickAction中携带data字段并设置actionType字段为0：
   收起

   自动换行

   深色代码主题

   复制

   // Request URL
   POST https://push-api.cloud.huawei.com/v1/[projectId]/service_notification/send
    
   // Request Header
   Authorization: Bearer eyJr*****OiIx---****.eyJh*****iJodHR--***.QRod*****4Gp---**** 
   
   // Request Body
   {
     "msgId": "2**********80",
     "appId": "6**********972",
     "toOpenId": "A**********O",
     "templateId": "1**********2",
     "templateParams": {
       "thing_0": "N0001",
       "time_1": "2024年4月27日 22:22",
       "thing_2": "软件大道101号"
     },
     "clickAction": {
       "actionType": 0,
       "data": { "testKey": "testValue" }
   }

   • actionType：点击消息的动作，0表示点击消息后进入首页。
   • data：点击消息时携带的JSON格式的数据，必须是key-value格式。

2. 在应用首页中（通常为项目模块级别下的src/main/module.json5中mainElement的值）的onCreate()方法中覆写如下代码：
   收起

   自动换行

   深色代码主题

   复制

   import { UIAbility, Want } from '@kit.AbilityKit';
   import { hilog } from '@kit.PerformanceAnalysisKit';
   
   export default class MainAbility extends UIAbility {
     onCreate(want: Want): void {
       // 获取消息中传递的data数据
       const data = want.parameters;
       hilog.info(0x0000, 'testTag', 'Succeeded in getting message data');
       // 根据实际业务场景对data进行处理
     }
   }

   onNewWant()方法中覆写如下代码：

   收起

   自动换行

   深色代码主题

   复制

   import { UIAbility, Want } from '@kit.AbilityKit';
   import { hilog } from '@kit.PerformanceAnalysisKit';
   
   export default class MainAbility extends UIAbility {
     onNewWant(want: Want): void {
       // 获取消息中传递的data数据
       const data = want.parameters;
       hilog.info(0x0000, 'testTag', 'Succeeded in getting message data');
       // 根据实际业务场景对data进行处理
     }
   }

   注意

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

3. 当点击消息首次进入应用首页时，会在onCreate()方法中获取消息data数据，当前应用进程存在时，点击新消息进入首页会在onNewWant()方法中获取消息数据。

点击消息进入应用指定页并传递数据

消息示例如下，更多详情请见服务通知。

1. 在您的项目模块级别下的src/main/module.json5 中设置待跳转Ability的skills标签中的actions或uris值。

   设置actions参数完成点击消息进入应用指定页示例（若skills中添加了uris参数，则uris内容需为空）：

   收起

   自动换行

   深色代码主题

   复制

   {
     "name": "TestAbility",
     "srcEntry": "./ets/abilities/TestAbility.ets",
     "exported": false,
     "startWindowIcon": "$media:icon",
     "startWindowBackground": "$color:start_window_background",
     "skills": [
       {
         "actions": [
           "com.test.action"
         ]
       }
     ]
   }

   设置uris参数完成点击消息进入应用指定页示例（skills中必须同时设置actions参数，actions参数为空字符），uris对象内部结构说明请参见skills标签。

   收起

   自动换行

   深色代码主题

   复制

   {
     "name": "TestAbility",
     "srcEntry": "./ets/abilities/TestAbility.ets",
     "exported": false,
     "skills": [
       {
         "actions": [""],
         "uris": [
           {
             "scheme": "https",
             "host": "www.xxx.com",
             "port": "8080",
             "path": "push/test"
           }
         ]
       }
     ]
   }

   注意

   • 设置待跳转ability时，仅设置上述action方式或uris方式中的一种即可。
   • module.json5文件中的skills标签下可以同时存在多个skill对象，每个对象对应一种能力。若您需要同时设置推送消息跳转能力和其他跳转能力（如NFC跳转、浏览器跳转等），需要在skills数组中创建不同的skill对象，分别映射对应的能力。

2. 发送消息时clickAction中携带data字段并设置actionType字段为1：
   收起

   自动换行

   深色代码主题

   复制

   // Request URL
   POST https://push-api.cloud.huawei.com/v1/[projectId]/service_notification/send
   
   // Request Header
   Authorization: Bearer eyJr*****OiIx---****.eyJh*****iJodHR--***.QRod*****4Gp---****
   
   // Request Body
   {
     "msgId": "2**********80",
     "appId": "6**********972",
     "toOpenId": "A**********O",
     "templateId": "1**********2",
     "templateParams": {
       "thing_0": "N0001",
       "time_1": "2024年4月27日 22:22",
       "thing_2": "软件大道101号"
     },
     "clickAction": {
       "actionType": 1,
       "action": "com.test.action",
       "uri": "https://www.xxx.com:8080/push/test",
       "data": { "testKey": "testValue" }
     }
   }

   • actionType：点击消息动作，1表示点击消息后进入元服务指定页。当本字段设置为1时，uri和action至少填写一个，若都填写优先寻找与action匹配的应用页面。
   • action：表示能够接收Want的action值的集合，取值可以自定义。与步骤1中设置的action保持一致。
   • uri：表示与Want中uris相匹配的集合，uris规则请参见skills标签。与步骤1中设置的uris保持一致。
   • data：点击消息时携带的JSON格式的数据，必须是key-value格式。

3. 在待跳转页面（下以TestAbility为例）中的onCreate()方法中覆写如下代码：
   收起

   自动换行

   深色代码主题

   复制

   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;
       hilog.info(0x0000, 'testTag', 'Succeeded in getting message data');
       // 根据实际业务场景对data进行处理
     }
   }

   onNewWant()方法中覆写如下代码：

   收起

   自动换行

   深色代码主题

   复制

   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;
       hilog.info(0x0000, 'testTag', 'Succeeded in getting message data');
       // 根据实际业务场景对data进行处理
     }
   }

   注意

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

4. 当点击消息首次进入应用内页面时，会在onCreate()方法中获取消息data数据；当前应用进程存在时，点击消息会在onNewWant()方法中获取消息数据。