目录

推送基于账号的订阅消息

场景介绍

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

频控规则

若订阅模板类型为“一次性订阅”,推送消息数量受控于元服务发起订阅请求并获得用户授权的次数。每次发送订阅消息都需要获取用户授权。当用户勾选 “总是保持以上选择” 之后,下次订阅调用serviceNotification.requestSubscribeNotification()不会再向用户弹窗,保持之前的选择。

若订阅模板类型为“长期性订阅”,推送消息数量将在服务通知的模板详情页说明,元服务可在模板限制的订阅周期及频次内多次下发通知,而无需用户再次进行订阅操作,详情见选用订阅模板。

开发指导

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

// 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支行"
  }
}

点击消息动作

[h2]点击消息进入元服务首页或指定页并传递数据

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

  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 参数跳转至该元服务内指定页面,详情请见调用方UIAbility指定启动页面。

    • data:点击消息时携带的JSON格式的数据,必须是key-value格式,最大长度1024字节。示例:{"key1": "value1", "key2": "value2"}

  2. data数据获取:点击消息首次进入元服务页面时,需在onCreate()方法中获取消息data数据;当元服务进程存在时,需在onNewWant()方法中获取消息data数据。

    在元服务首页中(通常为项目模块级别下的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. 对于ascf框架开发的元服务,可通过clickAction中的data传入启动参数,内容需为{ ascfPara: [key: string]: Object }结构,详情请见want参数解析。

    示例如下:

    {
      "clickAction": {
      "actionType": 0,
      "data": {
    "ascfPara": {
      "path" : "pages/index?key1=value1&key2=value2" // 指定携带数据{'key1':'value1', 'key2':'value2'}跳转到pages/index页面
    }      
      }
    }
    }

    元服务获取启动参数:

    可以在ASCF元服务的App的onLaunch、onShow或Page的onLoad生命周期中获取传递的启动参数信息。

    App({
      onLaunch(options) {      
        let path = options.path;       // 例如:pages/index
        let data = options.query;      // 例如:{'key1':'value1', 'key2':'value2'}
        console.info('data = ', data);
        console.info('path = ', path);
      }
      
      onShow(options) {      
        let path = options.path;       // 例如:pages/index
        let data = options.query;      // 例如:{'key1':'value1', 'key2':'value2'}
        console.info('data = ', data);
        console.info('path = ', path);
      }
    });
     
    Page({
               onLoad(query)
    {      
          console.info('query = ', query);  // 例如:{'key1':'value1', 'key2':'value2'}
    }
    });

业务响应码报错问题请参考业务响应码。

示例代码

可参考服务端示例代码进行开发接入,同时还可通过自助测试能力模拟服务器推送基于账号的订阅消息,并生成请求参数报文用于构造发送请求。