跳到主要内容

请求体结构说明

接口原型

  • 承载协议: HTTPS POST
  • 接口方向: 开发者服务器 -> 华为Push服务器
  • 接口URL: https://push-api.cloud.huawei.com/v3/****[projectId]****/messages:send
  • 数据格式: Content-Type: application/json

[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:应用内通话消息0

Request Body

参数是否必选参数类型描述
payloadObject推送消息结构体,不同的push-type场景拥有不同的payload定义: 0:AlertPayload 通知消息 1:FormUpdatePayload 卡片刷新消息 2:ExtensionPayload 语音播报消息 6:BackgroundPayload 后台消息 7:LiveViewPayload 实况窗消息 10:VoIPCallPayload 应用内通话消息
pushOptionsObject发送控制参数,详情请参见pushOptions的定义。
targetObject发送目标,详情请参见target的定义。