推送高级接口

系统规定参数。取值：Push。在旧版SDK的node.js、ruby场景下，取值为PushInner。

AppKey信息。

推送类型。取值：

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

设备类型，取值范围为：

• iOS：iOS设备
• ANDROID：Android设备
• ALL：全部设备类型

  说明 该参数仅对旧的不分端App有意义。新的分端App下，该参数填写“ALL”或与App分端类型对应的值均可。

推送目标。可取值：

• DEVICE：根据设备推送。
• ACCOUNT：根据账号推送。
• ALIAS：根据别名推送。
• TAG：根据标签推送。
• ALL：推送给全部设备（同一种DeviceType的两次全推的间隔至少为1秒）。

  说明 对iOS设备全推，会推送给24个月内活跃过但未卸载的设备，一旦APNs（苹果推送服务）接收到推送请求且未返回错误信息即为送达，导致活跃设备数暴增，从而产生大量费用，请您酌情使用。
• TBD：初始化持续推送，推送目标由后续的ContinuouslyPush接口指定。

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

• Target=DEVICE，值如deviceid1,deviceid2（最多支持1000个）。
• Target=ACCOUNT，值如account1,account2（最多支持1000个）。
• Target=ALIAS，值如alias1,alias2（最多支持1000个）。
• Target=TAG，支持单Tag和多Tag，格式请参见标签格式。
• Target=ALL，值为ALL。
• Target=TBD，值为TBD。

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

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

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

• accs：阿里云自有通道
• huawei：华为通道
• honor：荣耀通道
• xiaomi：小米通道
• meizu：魅族通道
• vivo：vivo通道
• oppo：OPPO通道
• apns：APNs通道

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

设置定时发送最迟不能晚于7天发送。

时间格式按照ISO8601标准表示，并需要使用UTC时间，格式为YYYY-MM-DDThh:mm:ssZ。注：Target为TBD（持续推送）时，不支持定时设置。

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

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

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

推送时通知/消息的标题，长度限制：200字节。

在Android推送时必填；在iOS通知时非必填，如果填写，则：

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

Android推送时通知的内容/消息的内容；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。

角标自增功能由推送服务端维护每个设备的角标计数，需要用户使用1.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的格式传入，否则会解析出错。

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

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

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

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

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

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

设定通知打开的activity。

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

Android收到推送后打开对应的url。

仅当AndroidOpenType=”URL”时传入。

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

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

长度限制：30字符。

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

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

长度限制：128字符。

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

通知样式，取值为：

• 0：标准模式（默认）
• 1：长文本模式
• 2：大图模式（仅支持小米）

当前支持：

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

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

• 当前仅支持荣耀通道和华为通道EMUI11及以上版本。
• 若长文本模式下未提供此参数，则从Title、AndroidPopupTitle里取第一个非空值。

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

当前支持：

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

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

大图模式下的大图URL。大图模式下图片上传至小米推送后会返回一个图片URL，本参数内填写这个URL。

大图标URL。

当前支持：

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

大图URL。当前支持：小米MIUI12及以上（仅长文本模式下适用）。

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

当前支持：

• 华为：EMUI9及以上
• 安卓SDK3.6.0及以上

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

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

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

设置NotificationChannel参数，具体用途请参见常见问题：Android 8.0以上设备通知接收不到。

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

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

需要在Huawei平台申请，申请链接。

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

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

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

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

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

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

需要在vivo平台申请，详见：申请链接。

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

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

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

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

• HIGH
• NORMAL

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

华为通道标识高优先级透传消息的特殊场景，取值如下：

• PLAY_VOICE：语音播报
• VOIP：VoIP电话

需申请特殊权限，详见：链接。

设置vivo通道通知类型：0：正式推送；1：测试推送。

测试推送请事先在vivo控制台配置测试设备。测试设备RegId可在设备启动日志中搜索“onReceiveRegId regId”获得。

Android通知声音（保留参数，当前暂不起作用）。

补发短信的模板名，可以在短信模板管理界面获取，是系统分配的名称，而非开发者设置的名称。

补发短信的签名。

短信模板的变量名值对，格式： key1=value1&key2=value2。

触发短信的延迟时间，秒。

推荐设置为 15 秒以上，避免短信和推送的重复。

触发短信的条件。可取值：

• 0：推送未收到时触发。
• 1：用户未打开时触发。

该参数已废弃。

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

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

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

标志一次推送的消息ID。

请求ID。