MassPush - 批量推送

推送类型。取值：

• MESSAGE：表示消息。
• NOTICE：表示通知。

设备类型，取值范围为：

• HARMONY：鸿蒙设备
• iOS：iOS 设备
• ANDROID：Android 设备
• ALL：当 AppKey 为旧版本双端应用时，代表同时推送 Android 和 iOS 设备；当 AppKey 为新版本单端应用时，效果和指定该应用类型对应的设备类型一样。

推送目标。可取值：

• DEVICE：根据设备推送。
• ACCOUNT：根据账号推送。
• ALIAS：根据别名推送。

根据 Target 来设定，多个值使用逗号分隔，超过限制需要分多次推送。

• Target=DEVICE，值如deviceid1,deviceid2（最多支持 1000 个）。
• Target=ACCOUNT，值如account1,account2（最多支持 1000 个）。
• Target=ALIAS，值如alias1,alias2（最多支持 1000 个）。

离线消息/通知是否保存。StoreOffline 默认设置为 false。

若保存，在推送时候用户不在线，在过期时间（ExpireTime）内用户上线时会被再次发送。ExpireTime 默认为 72 小时。iOS 通知走 APNs 链路，不受 StoreOffline 影响。

指定发送通道，取值如下：

• accs：阿里云自有通道
• huawei：华为通道
• honor：荣耀通道
• xiaomi：小米通道
• oppo：OPPO 通道
• vivo：vivo 通道
• meizu：魅族通道
• gcm：谷歌 GCM 通道（旧版 HTTP）
• fcm: 谷歌 Firebase 通道（HTTP v1 API）
• apns：APNs 通道
• harmony: 鸿蒙通道

用于定时发送。不设置缺省是立即发送。

时间格式按照 ISO8601 标准表示，并需要使用 UTC 时间，格式为 YYYY-MM-DDThh:mm:ssZ。

离线消息/通知的过期时间，和 StoreOffline 配合使用，过期则不会再被发送，最长保存 72 小时。默认为 72 小时。

时间格式按照 ISO8601 标准表示，并需要使用 UTC 时间，格式为 YYYY-MM-DDThh:mm:ssZ，过期时间不能小于当前时间或者定时发送时间加上 3 秒（ExpireTime > PushTime+3 秒），3 秒是为了冗余网络和系统延迟造成的误差。建议单推不小于 1 分钟，全推、批量推送不少于 10 分钟。

推送任务自定义标识，当 JobKey 不为空时，回执日志中会附带该字段。查看回执日志参见回执日志。

推送时通知/消息的标题，长度限制：200 字节。 在 Android 推送和 Harmony 推送时必填；在 iOS 推送通知时非必填，如果填写，则：

• iOS 10+通知显示标题。
• iOS 8.2 <= iOS 系统 < iOS 10：替换通知应用名称。

Android 和 Harmony 推送时通知的内容/消息的内容；iOS 消息/通知内容，推送的内容大小是有限制的，参见产品限制。

是否自动对过长标题、内容进行截断。 注：仅支持明确限制标题、内容的厂商通道，对 APNs、华为、荣耀通道等不限制标题、内容，只限制总请求体大小的不适用。

iOS 的通知是通过 APNs 中心来发送的，需要填写对应的环境信息。

• DEV：表示开发环境。
• PRODUCT：表示生产环境。

消息推送时设备不在线（即与移动推送的服务端的长连接通道不通），则这条推送会做为通知，通过苹果的 APNs 通道送达一次。

iOS 通知副标题内容（iOS 10+）。

iOS 消息转通知时使用的 iOS 通知内容，仅当 iOSApnsEnv=PRODUCT && iOSRemind 为 true 时有效。

iOS 通知声音。指定存放在 app bundle 或沙盒 Library/Sounds 目录下的音频文件名，请参见：iOS 推送如何设定通知声音。

若指定为空串（””），通知为静音；若不设置，默认填充 default 为系统提示音。

iOS 应用图标右上角角标。

是否开启角标自增功能，默认为 false。

角标自增功能由推送服务端维护每个设备的角标计数，需要用户使用 V1.9.5 以上版本的 SDK，并且需要用户主动同步角标数字到服务端。

是否开启 iOS 静默通知。

iOS 通知处理扩展标记（iOS 10+）。如果设为 true，则 APNs 推送的通知在弹出前，可先到达 Extension 进行处理。静默通知时，必须设为 true。

指定 iOS 通知 Category（iOS 10+）。

设备收到有相同 CollapseId 的消息，会合并成一条。设备不在线，连续发相同 CollapseId 的消息，通知栏只会显示一条，iOS 10+支持设置此参数。

通过该属性对 iOS 的远程通知进行分组，标记折叠的组别识别名。仅支持 iOS 12.0+版本。

中断级别，取值：

• passive：系统在不点灯、不播放声音的情况下将通知添加到通知列表中。

• active：系统立即显示通知，点亮屏幕，并可以播放声音。

• time-sensitive：系统立即呈现通知，点亮屏幕，并可以播放声音，但不会突破系统通知控制。

• critical：系统立即显示通知，屏幕亮起，并绕过静音开关播放声音。

摘要突出显示分数。取值范围：[0,1]的浮点数。

iOS 通知的扩展属性。

iOS10+可以在此指定富媒体推送通知的资源 Url：{"attachment": "https://xxxx.xxx/notification_pic.png"} 。该参数要以 JSON map 的格式传入，否则会解析出错。

启动、更新、结束实时活动。

• 枚举：start | update | end

由设备上报到用户服务器的 Live Activity ID，Live Activity 的唯一标识符。

待启动的 Live Activity 类型。

JSON 字符串，灵动岛推送透传静态参数。包含静态的用户自定义信息，如产品编号、订单信息等。

灵动岛推送透传动态参数，包含实时更新信息，如价格、库存变化等

结束的 Live Activity 在锁屏上会保留到该指定时间，最长为 4 小时。

秒级时间戳，标记该活动的内容过期时间。

通知的提醒方式。可取值：

• VIBRATE：振动（默认值）
• SOUND：声音
• BOTH：声音和振动
• NONE：静音

推送类型为消息时设备不在线，则这条推送会使用辅助弹窗功能。默认值为 false，仅当 PushType=MESSAGE 时生效。

如果消息转通知推送成功，收到通知是展示的数据为服务端设置的 AndroidPopupTitle 和 AndroidPopupBody 参数值，点击通知在辅助弹窗的 onSysNoticeOpened 方法中获取到的数据是服务端设置的 Title 和 Body 参数值。

点击通知后动作。可取值：

• APPLICATION：打开应用（默认值）
• ACTIVITY：打开应用 AndroidActivity
• URL：打开 URL
• NONE：无跳转

设定通知打开的 activity。

仅当 PushTask.N.AndroidOpenType=”Activity”时传入，如：com.alibaba.cloudpushdemo.bizactivity。

Android 收到推送后打开对应的 url。仅当 PushTask.N.AndroidOpenType=”URL”时传入。

指定点击通知后跳转的 Activity。

辅助弹窗模式下标题内容。AndroidPopupActivity 参数不为空时，该参数必填。

长度限制：30 字符。

如使用厂商通道，则需同时符合厂商通道的限制，具体内容参见： Android 端辅助通道推送限制。

辅助弹窗模式下 Body 内容。AndroidPopupActivity 参数不为空时，该参数必填。

长度限制：128 字符。

如使用厂商通道，则需同时符合厂商通道的限制，具体内容参见： Android 端辅助通道推送限制。

通知样式，取值为：

• 0：标准模式（默认）
• 1：长文本模式（支持华为、荣耀、小米、OPPO、魅族、自有通道）
• 2：大图模式（仅支持小米）
• 3：列表模式（支持华为、荣耀、小米、OPPO、自有通道）

长文本模式下的标题，长度限制：200 个字节（1 个汉字算作 3 字节）。

• 当前仅支持荣耀通道和华为通道 EMUI11 及以上版本。

• 若长文本模式下未提供此参数，则从 Title、AndroidPopupTitle 里取第一个非空值。

长文本模式下的 body，长度限制：1000 字节（1 个汉字算作 3 字节），发送时受具体厂商通道的限制。

当前支持：

• 　华为：EMUI10 及以上
• 　荣耀：Magic UI 4.0 及以上
• 　小米：MIUI10 及以上
• 　OPPO：ColorOS5.0 以上
• 　魅族：Flyme
• 　自有通道：安卓 SDK3.6.0 及以上

若长文本模式下未提供此参数，则从 Body、AndroidPopupBody 里取第一个非空值。

大图模式下的图片 URL，当前支持：自有通道：安卓 SDK3.6.0 及以上。

该参数已废弃，小米从 2023.08 开始，官方在新设备/系统已经不再支持推送时动态设置小图标、右侧图标、大图片功能。

大图标 URL。当前支持：

• 华为 EMUI（仅长文本模式、Inbox 模式下适用）
• 荣耀 Magic UI（仅长文本模式下适用）
• 自有通道：安卓 SDK3.5.0 及以上

该参数已废弃，小米从 2023.08 开始，官方在新设备/系统已经不再支持推送时动态设置小图标、右侧图标、大图片功能。

Inbox 模式下的正文，内容为合法的 JSON Array，且元素不超过 5 个。当前支持：

• 华为：EMUI9 及以上
• 荣耀：Magic UI 4.0 及以上
• 小米：MIUI10 及以上
• OPPO：ColorOS 5.0 以上
• 自有通道：安卓 SDK3.6.0 及以上

Android 自定义通知栏样式，取值：1-100。

Android 通知在通知栏展示时排列位置的优先级。可取值： -2，-1，0，1，2。

标识每条消息在通知显示时的唯一标识，不同的通知栏消息可以相同的 NotifyId，实现新的通知栏消息覆盖老的，当前支持除 FCM 通道外的其他厂商通道。

Android app 的 channelId，需要与 app 中的 channelId 能对应上。

• 设置 NotificationChannel 参数，具体用途请参见常见问题：Android 8.0 以上设备通知接收不到。
• 因 OPPO 通知私信通道的 channel_id 与 app 的 channelId，故 OPPO 通道推送时，channel_id 取此值。
• 华为、FCM、阿里云自有通道推送中，channel_id 取此值。

设置 Huawei 通知消息分类 importance 参数，决定用户设备消息通知行为，取值如下：

• LOW：资讯营销类消息
• NORMAL：服务与通讯类消息

设置荣耀通知消息分类 importance 参数，决定用户设备消息通知行为，取值如下：

• LOW：资讯营销类消息

• NORMAL：服务与通讯类消息

需要在荣耀平台申请，申请链接。

设置小米通知类型的 channelId，需要在小米平台申请，详见：申请链接。

设置 vivo 通知消息分类，取值为：

• 0：运营类消息（默认）
• 1：系统类消息

消息分组，同一组消息在通知栏里只显示最新一条和当前该组接受到的消息总数目，不会展示所有消息也无法展开。当前支持：

• 华为
• 荣耀
• 自有通道

消息分组，同一组消息在通知栏里折叠展示，可展开，不同组通知分开展示。当前支持：

• 自有通道 安卓 SDK3.9.2 及以上

设定通知的扩展属性。当推送类型 PushType 设置为 MESSAGE 消息类型时，该属性不生效。

该参数要以 JSON map 的格式传入，否则会解析出错。

华为通道透传消息投递优先级，取值如下：

• HIGH

• NORMAL

需要申请权限，具体请参见：申请链接。

作用一：完成自分类权益申请后，用于标识消息类型，确定消息提醒方式，对特定类型消息加快发送，取值请参考华为推送官方文档的消息分类标准，填写文档表格中的“云端通知 category 取值”或“本地通知 category 取值”。

作用二：申请特殊权限后，用于标识高优先级透传场景，取值如下：

• VOIP：音视频通话
• PLAY_VOICE：语音播报

OPPO 将消息分类：通讯与服务、内容与营销两个类别进行管理。

通讯与服务（需申请权限）：

• IM：即时聊天、音频、视频通话
• ACCOUNT：个人账号与资产变化
• DEVICE_REMINDER：个人设备提醒
• ORDER：个人订单/物流状态变化
• TODO：个人日程/待办
• SUBSCRIPTION：个人订阅

内容与营销：

• NEWS：新闻资讯
• CONTENT：内容推荐
• MARKETING：平台活动
• SOCIAL：社交动态

详细请参考 OPUSH 消息分类细则

OPPO 通道通知栏消息提醒等级。可取值为：

• 1：通知栏
• 2：通知栏+锁屏（通讯与服务类消息默认通知级别）
• 16：通知栏+锁屏+横幅+震动+铃声（需申请权限）

vivo 将消息分为：系统消息、运营消息两个类别进行管理。

系统消息：

• IM：即时消息
• ACCOUNT：账号与资产
• TODO：日程待办
• DEVICE_REMINDER：设备信息
• ORDER：订单与物流
• SUBSCRIPTION：订阅提醒

运营消息：

• NEWS：新闻
• CONTENT：内容推荐
• MARKETING：运营活动
• SOCIAL：社交动态

设置厂商通道通知类型：

• 0：正式通知（默认）。
• 1：测试通知。

设置华为通道通知类型：

• 0：正式通知（默认）。
• 1：测试通知。

设置荣耀通道通知类型：

• 0：正式通知（默认）。
• 1：测试通知。

设置 vivo 通道通知类型：

• 0：正式推送（默认）。
• 1：测试推送。

华为通道回执 ID，该回执 ID 可以在华为通道推送运营平台的回执参数配置中查看。

vivo 通道回执 ID，该回执 ID 可以在 vivo 开放平台推送服务的应用信息中查看。

角标设置应用入口 Activity 的全类名

设置角标累加值，在原角标的基础上进行累加

设置角标数字固定值

华为厂商通道通知声音。指定存放在客户端项目 app/src/main/res/raw/目录下的音频文件名，不需要携带文件格式后缀名。

若不设置，则使用默认铃声。

推送类型为消息时设备不在线，则这条推送会使用辅助弹窗功能。默认值为 false，仅当 PushType=MESSAGE 时生效。

如果消息转通知推送成功，收到通知是展示的数据为服务端设置的 HarmonyRemindTitle 和 HarmonyRemindBody 参数值。

Harmony 消息转通知时使用的 Harmony 通知标题，仅当 HarmonyRemind 为 true 时有效。

Harmony 消息转通知时使用的 Harmony 通知内容，仅当 HarmonyRemind 为 true 时有效。

通知消息类别。完成申请通知消息自分类权益后，用于标识消息类型，不同的通知消息类型影响消息展示和提醒方式。取值如下：

• IM：即时聊天
• VOIP：音视频通话
• SUBSCRIPTION：订阅
• TRAVEL：出行
• HEALTH：健康
• WORK：工作事项提醒
• ACCOUNT：账号动态
• EXPRESS：订单&物流
• FINANCE：财务
• DEVICE_REMINDER：设备提醒
• MAIL：邮件
• CUSTOMER_SERVICE：客服消息
• MARKETING：新闻、内容推荐、社交动态、产品促销、财经动态、生活资讯、调研、功能推荐、运营活动（仅对内容进行标识，不会加快消息发送），统称为资讯营销类消息

详情参见鸿蒙官网 Notification.category

使用指定类型的通知渠道。仅在阿里云自有通道在线时有效。

• SOCIAL_COMMUNICATION: 社交通信。
• SERVICE_INFORMATION: 服务提醒。
• CONTENT_INFORMATION: 内容资讯。
• CUSTOMER_SERVICE: 客服消息。该类型用于用户与商家之间的客服消息，需由用户主动发起。
• OTHER_TYPES: 其他。

详情参见鸿蒙官网 SlotType

每条消息在通知显示时的唯一标识。不携带时，推送服务自动为每条消息生成一个唯一标识；不同的通知消息可以拥有相同的 notifyId，实现新消息覆盖旧消息功能。

详情参见鸿蒙官网 Notification.notifyId

点击通知后动作。可取值：

• APP_HOME_PAGE：打开应用首页
• APP_CUSTOM_PAGE：打开应用自定义页面

应用内置页面 ability 对应的 action。

详情参见鸿蒙官网 ClickAction.action

应用内置页面 ability 对应的 uri。

详情参见鸿蒙官网 ClickAction.uri

通知消息样式：

• NORMAL: 普通通知（默认值）
• MULTI_LINE: 多行文本样式

通知右侧大图标 URL，URL 使用的协议必须是 HTTPS 协议。

详情参见鸿蒙官网 Notification.image

多行文本样式的内容，当 HarmonyRenderStyle 为 MULTI_LINE 时，本字段必填，最多支持 3 条内容。

设定通知的扩展属性。当推送类型 PushType 设置为 MESSAGE 消息类型时，该属性不生效。

该参数要以 JSON map 的格式传入，否则会解析出错。

测试消息标识：

• false：正常消息（默认值）
• true：测试消息

详情参见鸿蒙官网 pushOptions.testMessage

鸿蒙通道回执 ID，该回执 ID 可以在鸿蒙通道推送运营平台的回执参数配置中查看。

详情参见鸿蒙官网 pushOptions.receiptId

PushType 为 NOTICE 时，是否为鸿蒙通知扩展消息。

• true：发送通知扩展消息
• false：发送普通通知(默认值)

通知扩展消息需要先在鸿蒙侧申请权限才能发送，相关内容请参考鸿蒙文档发送通知扩展消息。
鸿蒙 SDK1.2.0 版本开始支持。

通知扩展消息的额外数据。
发送鸿蒙通知扩展消息时有效。
概念上等同鸿蒙通知扩展消息的 extraData 字段，具体定义参考鸿蒙 ExtensionPayload 说明。
鸿蒙 SDK1.2.0 版本开始支持。

鸿蒙应用角标累加数字。参考鸿蒙角标 addNum 字段说明。
鸿蒙 SDK1.2.0 版本开始支持。

鸿蒙应用角标设置数字。参考鸿蒙角标 setNum 字段说明。
鸿蒙 SDK1.2.0 版本开始支持。

该参数已废弃。

该参数已废弃，所有第三方辅助弹窗都由新参数 AndroidPopupTitle 统一支持。

该参数已废弃，所有第三方辅助弹窗都由新参数 AndroidPopupBody 统一支持。

该参数已废弃，所有第三方辅助弹窗都由新参数 AndroidPopupActivity 统一支持。