文档中心 登录/注册 SDK下载 个推学堂

当前位置：个推文档 > 服务端 > Open Harmony API > 场景化消息-请求体参数说明

场景化消息-请求体参数说明

场景化消息-请求体参数说明

pushOptions

参数 是否必选 参数类型 描述
testMessage 否 Boolean 此功能暂不支持
ttl 否 Integer 此功能暂不支持
biTag 否 String 此功能暂不支持
receiptId 否 String 此功能暂不支持
collapseKey 否 Integer 此功能暂不支持
backgroundMode 否 Integer 此功能暂不支持

target

参数 是否必选 参数类型 描述
token 是 Array [String] 按照Token向目标用户推送消息。
示例{"token": ["o39qt*******"]}
注意单次最多携带1000个Token。

AlertPayload 通知消息

参数 是否必选 参数类型 描述
notification 是 Notification Object 通知消息结构体

Notification

参数 是否必选 参数类型 描述
category 是 String 通知消息类型。用于标识消息类型，不同的通知消息类型影响消息展示和提醒方式。取值如下：
服务与通讯类
IM：即时聊天
VOIP：语音通话邀请、视频通话邀请
MISS_CALL：未接通话消息提醒
SUBSCRIPTION：订阅
TRAVEL：出行
HEALTH：健康
WORK：工作事项提醒
ACCOUNT：账号动态
EXPRESS：订单&物流
FINANCE：财务
DEVICE_REMINDER：设备提醒
MAIL：邮件
PLAY_VOICE：语音播报(仅可发送push-type为2的语音播报消息)

资讯营销类
MARKETING：新闻、内容推荐、社交动态、产品促销、财经动态、生活资讯、调研、功能推荐、运营活动（仅对内容进行标识，不会加快消息发送），统称为资讯营销类消息。
title 是 String 通知消息标题。（注意消息体大小限制，详情参见功能介绍-使用约束）
body 是 String 通知消息内容。（注意消息体大小限制，详情参见功能介绍-使用约束）
image 否 String 通知右侧大图标URL，URL使用的协议必须是HTTPS协议。（注意消息体大小限制，详情参见功能介绍-使用约束）说明：
Wearable不支持右侧大图标样式。
支持图片格式为PNG、JPG、JPEG、BMP，图片长宽建议小于128128像素，若超过49152像素，则图片不展示。
style 否 Integer 通知消息样式：
0：普通通知（默认值）
1：大文本样式
3：多行文本样式
注意:
style=1 大文本样式将要废弃，建议直接使用 style=0 普通通知。
Wearable不支持大文本样式和多行文本样式。
bigTitle 否 String 大文本样式的标题，当style为1时必选。设置bigTitle后通知栏展示时，使用bigTitle而不用title。（注意消息体大小限制，详情参见功能介绍-使用约束）
注意:
此字段将要废弃，建议直接使用title字段。
Wearable不支持大文本样式。
bigBody 否 String 大文本样式的内容，当style为1时必选。设置bigBody后通知栏展示时，使用bigBody而不用body。（注意消息体大小限制，详情参见功能介绍-使用约束）
注意:
此字段将要废弃，建议直接使用body字段。Wearable不支持大文本样式。
notifyId 否 Integer 每条消息在通知显示时的唯一标识。不携带或者设置-1时，推送服务自动为每条消息生成一个唯一标识；不同的通知消息可以拥有相同的notifyId，实现新消息覆盖旧消息功能。
appMessageId 否 String 应用消息的唯一标识，不携带时默认无appMessageId。长度范围为[1,64]，支持大小写字母、数字、+、/、=、-、_和空白字符。
注意：
当同一appMessageId的应用消息通过多个渠道（Push Kit，近场通讯，应用自己拉取或发送本地通知）触达时，目标终端只展示有效期内最早的一条，有效期默认为24小时。
区别于notifyId, notifyId作用机制是新消息覆盖旧消息。特别地，notifyId和appMessageId均相同时，展示旧消息。
profileId 否 String 应用内账号id匿名标识，最大长度为64。
inboxContent 否 Array [String] 多行文本样式的内容，当style为3时，本字段必填，最多支持3条内容，每条最大长度1024且无法完全展示时以“...”截断。
示例：`"inboxContent": [ "1. 通知栏消息样式", "2. 通知栏消息提醒方式和展示方式", "3. 通知栏消息语言本地化"]
注意：
Wearable不支持多行文本样式。
clickAction 是 ClickAction Object 点击消息动作，详情请参见ClickAction结构体。
badge 否 Badge Object 通知消息角标控制参数，详情请参见Badge结构体，不设置时应用不显示角标数字，若当前已存在角标，则角标数字不变化。
示例：{ "badge": { "addNum": 1 }}
注意：
Wearable、TV不支持通知角标样式。
sound 否 String 自定义消息通知铃声。此处设置的铃声文件必须放在应用的/resources/rawfile路径下。例如设置为alert.mp3，对应应用本地的/resources/rawfile/alert.mp3文件。支持的文件格式包括MP3、WAV、MPEG等，如果不设置，则用默认系统铃声。当请求不携带soundDuration字段时，建议铃声时长不超过30秒，若超过30秒则截断处理；当请求携带soundDuration字段时，详情请参见soundDuration字段说明。
注意：
Wearable、TV、PC/2in1不支持自定义铃声。
soundDuration 否 Integer 自定义消息通知铃声时长。需要配合sound字段使用，只有当请求同时携带sound字段，soundDuration字段才会生效。仅支持数字，单位为秒，取值范围 [1, 60]。
sound字段传入的自定义消息通知铃声会播放至soundDuration字段值后停止，若自定义消息通知铃声对应的时长不足soundDuration字段值则会循环播放，在达到soundDuration字段值后停止。
foregroundShow 否 Boolean 应用在前台时是否展示通知消息。默认为true，表示前后台都展示。
true：默认值，应用在前后台都展示通知消息，此时receiveMessage不会被触发，无法获取消息数据。
false：应用只在后台展示通知消息；应用在前台时，通知消息将不会展示，但可以通过receiveMessage接收通知消息自行完成业务处理。

ClickAction

参数 是否必选 参数类型 描述
actionType 是 Integer 消息点击后的行为。
0：打开应用首页
1：打开应用自定义页面
在不同的场景下支持actionType不同，详情请参考点击行为类型。
action 否 String 应用内置页面ability对应的action。当actionType为1时，字段uri和action至少填写一个。当action对应的页面路径不存在时，会默认跳转应用首页。
uri 否 String 应用内置页面ability对应的uri。当actionType为1时，字段uri和action至少填写一个。当存在多个Ability时，分别填写不同Ability的action和uri，优先使用action查找对应的应用内置页面。
data 否 Object 点击时传递给应用的数据，格式为JSON对象。（注意消息体大小限制，详情参见功能介绍-使用约束）

点击行为类型

push-type 字段 actionType枚举值
0 Alert消息 notification.clickAction 0：打开应用首页
1：打开应用自定义页面
2 语音播报消息 notification.clickAction 0：打开应用首页
1：打开应用自定义页面

Badge

参数 是否必选 参数类型 描述
addNum 否 Integer 应用角标累加数字（大于0小于100的整数），非应用角标实际显示数字。
说明：
某应用当前有N条未读消息，若addNum设置为3，则每发一次消息，应用角标显示的数字累加3，为N+3（若N+3 > 99，角标显示“99”）。
当不传入addNum时默认值为0，角标不会增加。
setNum 否 Integer 角标设置数字（大于等于0小于100的整数），应用角标实际显示数字。
说明：
setNum优先级高于addNum：
若未传入setNum，说明未下发setNum，则本次以addNum为准。
若setNum>=0，说明下发了setNum，则本次以setNum为准。发布通知时不携带addNum字段。

ExtensionPayload 语音播报消息

参数 是否必选 参数类型 描述
notification 是 Notification Object 通知消息结构体，详情请参见Notification结构体。
注意：
notification.category必填，且取值为“PLAY_VOICE”。
extraData 是 String 语音播报消息的额外数据。（注意消息体大小限制，详情参见功能介绍-使用约束）

BackgroundPayload 后台消息

参数 是否必选 参数类型 描述
extraData 是 String 传递给应用的数据。（注意消息体大小限制，详情参见功能介绍-使用约束）
Push检测应用是否在前台，应用如果在前台则传递到目标应用，如果不在前台，则缓存或静默写入应用自身缓存。
proxyData 否 String 应用进程不在前台时是否走数据代理静默写入到应用自身缓存，当前只能传全大写"ENABLE"。若您不希望开启代理写入，请不要在消息体中填写此字段。

VoIPCallPayload 应用内通话消息

参数 是否必选 参数类型 描述
extraData 是 String 传递给应用的数据，应用根据数据自行处理相关逻辑，展示应用内通话消息相关信息。（注意消息体大小限制，详情参见功能介绍-使用约束）
在这篇文章中： pushOptions target AlertPayload 通知消息 ExtensionPayload 语音播报消息 BackgroundPayload 后台消息 VoIPCallPayload 应用内通话消息
开发者中心 SDK 下载

文档中心搜索

技术
咨询

微信扫一扫

随时联系技术支持

在线
咨询