目录

请求体结构说明

接口原型

[projectId] :项目ID,登录AppGallery Connect网站,选择“开发与服务”,在项目列表中选择对应的项目,左侧导航栏选择“项目设置”,在该页面中获取。

Request Header

参数 取值描述 样例
Authorization

鉴权方式:JWT方式。

说明:

HarmonyOS 5及以上系统版本推送不再支持OAuth 2.0开放鉴权方式。

详情参见基于服务账号生成鉴权令牌。

说明:

建议JWT令牌过期时间设置为3600秒,有效期内可以复用。

Bearer后面拼接空格,再拼接获取的鉴权信息。

Bearer eyJr*****OiIx---****.eyJh*****iJodHR--***.QRod*****4Gp---****
push-type

消息类型,取值如下:

0:Alert消息(通知消息、角标刷新消息)

1:卡片刷新消息

2:语音播报消息

6:后台消息

7:实况窗消息

10:应用内通话消息

11:MDM消息

0

Request Body

参数 是否必选 参数类型 描述
payload 是 Object

推送消息结构体,不同的push-type场景拥有不同的payload定义:

0:AlertPayload 通知消息

0:BadgePayload 角标刷新消息

1:FormUpdatePayload 卡片刷新消息

2:ExtensionPayload语音播报消息

6:BackgroundPayload后台消息

7:LiveViewPayload实况窗消息

10:VoIPCallPayload 应用内通话消息

11:MdmPayloadMDM消息

pushOptions 否 Object 发送控制参数,详情请参见pushOptions的定义。
target 是 Object 发送目标,详情请参见target的定义。
Request Header
├── Content-Type: application/json
├── Authorization: 接口鉴权令牌
└── push-type: 场景化消息类型

Request Body
├── pushOptions
│    ├── testMessage: 测试消息标识字段
│    └── 其他参数……
├── payload
│    # 类型一:通知消息,详见AlertPayload结构体
│    └── notification
│         ├── category: 消息类型
│         ├── title: 通知标题
│         ├── body: 通知内容
│         └── 其他参数……
│
│    # 类型二:卡片刷新消息,详见FormUpdatePayload结构体
│    └── formUpdate
│         ├── formId: 服务卡片的实例ID
│         ├── version: 卡片刷新消息的版本号
│         ├── images: 服务卡片图片数据
│         └── 其他参数……
│
│    # 类型三:语音播报消息,详见ExtensionPayload结构体
│    ├── notification
│    │    ├── category: 消息类型
│    │    ├── title: 通知标题
│    │    ├── body: 通知内容
│    │    └── 其他参数……
│    └── extraData: 扩展数据
│
│    # 其他类型……
│
└── target
     └── token: Push Token