- 推送相关接口
- 查询相关接口
- 标签相关接口
- 别名相关接口
- 账号相关接口
- 其他接口
- 后续下线接口(不建议使用)
接口说明
请确保在使用该接口前，以充分了解 EMAS 移动推送产品的收费方式和价格。
本接口区分 Android 和 iOS 平台，对于不同平台的推送调用，需要传入平台对应的 AppKey。
请求参数
| 字段名称 | 字段详情 |
|---|---|
AppKeyinteger<int64> | AppKey 信息。 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:23267207 |
PushTypestring | 推送类型。取值：展开详情 示例值:MESSAGE枚举值:MESSAGENOTICE |
DeviceTypestring | 设备类型，取值范围为：展开详情 示例值:HARMONY枚举值:ALLANDROIDiOS |
Targetstring | 推送目标。可取值：展开详情 示例值:ALL枚举值:ALLDEVICEACCOUNTALIASTAGTBDFILE |
TargetValuestring | 根据 Target 来设定，多个值使用逗号分隔，超过限制需要分多次推送。展开详情 示例值:ALL |
StoreOfflineboolean | 离线消息、通知是否保存。StoreOffline 默认设置为 false。展开详情 示例值:false |
SendChannelsstring | 指定发送通道，取值如下：展开详情 示例值:accs,huawei,xiaomi |
PushTimestring | 用于定时发送。不设置缺省是立即发送。展开详情 示例值:2019-02-20T00:00:00Z |
ExpireTimestring | 离线消息/通知的过期时间，和 StoreOffline 配合使用，过期则不会再被发送，最长保存 72 小时。默认为 72 小时。展开详情 示例值:2019-02-20T00:00:00Z |
JobKeystring | |
Titlestring | 推送时通知/消息的标题，长度限制：200 字节。展开详情 示例值:title |
Bodystring | Android 和 Harmony 推送时通知的内容/消息的内容；iOS 消息/通知内容，推送的内容大小是有限制的，参见产品限制。 示例值:hello |
Trimboolean | 是否自动对过长标题、内容进行截断。展开详情 示例值:false |
iOSApnsEnvstring | iOS 的通知是通过 APNs 中心来发送的，需要填写对应的环境信息。展开详情 示例值:DEV枚举值:DEVPRODUCT |
iOSRemindboolean | 消息推送时设备不在线（即与移动推送的服务端的长连接通道不通），则这条推送会做为通知，通过苹果的 APNs 通道送达一次。展开详情 示例值:true |
iOSSubtitlestring | iOS 通知副标题内容（iOS 10+）。 示例值:su'b |
iOSRemindBodystring | iOS 消息转通知时使用的 iOS 通知内容，仅当 iOSApnsEnv=PRODUCT && iOSRemind 为 true 时有效。 示例值:ios通知body |
iOSMusicstring | iOS 通知声音。指定存放在 app bundle 或沙盒 Library/Sounds 目录下的音频文件名，请参见： iOS 推送如何设定通知声音。展开详情 示例值:"" |
iOSBadgeinteger<int32> | iOS 应用图标右上角角标。展开详情 示例值:0 |
iOSBadgeAutoIncrementboolean | 是否开启角标自增功能，默认为 false。展开详情 示例值:true |
iOSSilentNotificationboolean | 是否开启 iOS 静默通知。 示例值:true |
iOSMutableContentboolean | iOS 通知处理扩展标记（iOS 10+）。如果设为 true，则 APNs 推送的通知在弹出前，可先到达 Extension 进行处理。静默通知时，必须设为 true。 示例值:true |
iOSNotificationCategorystring | 指定 iOS 通知 Category（iOS 10+）。 示例值:ios |
iOSNotificationCollapseIdstring | 设备收到有相同 CollapseId 的消息，会合并成一条。设备不在线，连续发相同 CollapseId 的消息，通知栏只会显示一条，iOS 10+支持设置此参数。 示例值:ZD2011 |
iOSNotificationThreadIdstring | 通过该属性对 iOS 的远程通知进行分组，标记折叠的组别识别名。展开详情 示例值:abc |
iOSInterruptionLevelstring | 中断级别，取值：展开详情 示例值:active |
iOSRelevanceScorenumber<double> | 摘要突出显示分数。取值范围：[0,1]的浮点数。 示例值:0.01 |
iOSExtParametersstring | iOS 通知的扩展属性。展开详情 示例值:{"attachment": "https://xxxx.xxx/notification_pic.png"} |
iOSLiveActivityEventstring | 启动、更新、结束实时活动。展开详情 示例值:start枚举值:startupdateend |
iOSLiveActivityIdstring | 由设备上报到用户服务器的 Live Activity ID，Live Activity 的唯一标识符。 示例值:66B94673-B32E-4CA7-863C-3E523054FD46 |
iOSLiveActivityAttributesTypestring | 待启动的 Live Activity 类型。展开详情 示例值:OrderActivityAttributes |
iOSLiveActivityAttributesstring | JSON 字符串，灵动岛推送透传静态参数。包含静态的用户自定义信息，如产品编号、订单信息等。展开详情 示例值:{"orderId": "12345", "product": "Shoes"} |
iOSLiveActivityContentStatestring | 灵动岛推送透传动态参数，包含实时更新信息，如价格、库存变化等 示例值:{"status": "delivered", "estimatedArrival": "2023-12-31T12:00:00Z"} |
iOSLiveActivityDismissalDateinteger<int64> | 秒级时间戳，结束的 Live Activity 在锁屏上会保留到该指定时间，最长为 4 小时。 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:1743131967 |
iOSLiveActivityStaleDateinteger<int64> | 秒级时间戳，标记该活动的内容过期时间。 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:1743131967 |
AndroidNotifyTypestring | 通知的提醒方式。可取值：展开详情 示例值:BOTH枚举值:NONEVIBRATESOUNDBOTH |
AndroidRemindboolean | 推送类型为消息时设备不在线，则这条推送会使用辅助弹窗功能。默认值为 false，仅当 PushType=MESSAGE 时生效。展开详情 示例值:true |
AndroidOpenTypestring | 点击通知后动作。可取值：展开详情 示例值:APPLICATION枚举值:APPLICATIONACTIVITYURLNONE |
AndroidActivitystring | 设定通知打开的 activity。展开详情 示例值:com.alibaba.cloudpushdemo.bizactivity |
AndroidOpenUrlstring | Android 收到推送后打开对应的 url。展开详情 示例值:https://xxxx.xxx |
AndroidPopupActivitystring | 指定点击通知后跳转的 Activity。 示例值:com.alibaba.cloudpushdemo.bizactivity |
AndroidPopupTitlestring | 辅助弹窗模式下标题内容。AndroidPopupActivity 参数不为空时，该参数必填。 展开详情 示例值:hello |
AndroidPopupBodystring | 辅助弹窗模式下 Body 内容。AndroidPopupActivity 参数不为空时，该参数必填。展开详情 示例值:hello |
AndroidRenderStyleinteger<int32> | 通知样式，取值为：展开详情 示例值:1枚举值:012 |
AndroidBigTitlestring | 长文本模式下的标题，长度限制：200 个字节（1 个汉字算作 3 字节）。展开详情 示例值:示例长标题 |
AndroidBigBodystring | 长文本模式下的 body，长度限制：1000 字节（1 个汉字算作 3 字节），发送时受具体厂商通道的限制。展开详情 示例值:示例长文本 |
AndroidBigPictureUrlstring | 大图模式下的图片 URL，当前支持：自有通道：安卓 SDK3.6.0 及以上。 示例值:https://imag.example.com/image.png |
deprecatedAndroidXiaomiBigPictureUrlstring | 该参数已废弃，小米从 2023.08 开始，官方在新设备/系统已经不再支持推送时动态设置小图标、右侧图标、大图片功能。 示例值:https://f6.market.xiaomi.com/download/MiPass/aaa/bbb.png |
AndroidImageUrlstring | 大图标 URL。展开详情 示例值:https://imag.example.com/image.png |
deprecatedAndroidXiaomiImageUrlstring | 该参数已废弃，小米从 2023.08 开始，官方在新设备/系统已经不再支持推送时动态设置小图标、右侧图标、大图片功能。 示例值:https://imag.example.com/image.png |
AndroidInboxBodystring | Inbox 模式下的正文，内容为合法的 JSON Array，且元素不超过 5 个。当前支持：展开详情 示例值:["第一行","第二行"] |
AndroidNotificationBarTypeinteger<int32> | Android 自定义通知栏样式，取值：1-100。 示例值:2取值 <= 100 |
AndroidNotificationBarPriorityinteger<int32> | Android 通知在通知栏展示时排列位置的优先级。可取值： -2，-1，0，1，2。 示例值:0取值 <= 2 |
AndroidNotificationNotifyIdinteger<int32> | 标识每条消息在通知显示时的唯一标识，不同的通知栏消息可以相同的 NotifyId，实现新的通知栏消息覆盖老的，当前支持除 FCM 通道外的其他厂商通道。 示例值:100001 |
AndroidNotificationChannelstring | Android app 的 channelId，需要与 app 中的 channelId 能对应上。展开详情 示例值:1 |
AndroidNotificationHuaweiChannelstring | 设置 Huawei 通知消息分类 importance 参数，决定用户设备消息通知行为，取值如下：展开详情 示例值:LOW枚举值:LOWNORMAL |
AndroidNotificationHonorChannelstring | 设置荣耀通知消息分类 importance 参数，决定用户设备消息通知行为，取值如下：展开详情 示例值:LOW枚举值:LOWNORMAL |
AndroidNotificationXiaomiChannelstring | |
AndroidNotificationVivoChannelstring | 设置 vivo 通知消息分类，取值为：展开详情 示例值:classification枚举值:01 |
AndroidNotificationGroupstring | 消息分组，同一组消息在通知栏里只显示最新一条和当前该组接受到的消息总数目，不会展示所有消息也无法展开。当前支持：展开详情 示例值:group-1 |
AndroidNotificationThreadIdstring | 消息分组，同一组消息在通知栏里折叠展示，可展开，不同组通知分开展示。当前支持：展开详情 示例值:thread-1 |
AndroidExtParametersstring | 设定通知的扩展属性。当推送类型 PushType 设置为 MESSAGE 消息类型时，该属性不生效。展开详情 示例值:{"key1":"value1","api_name":"PushNoticeToAndroidRequest"} |
AndroidMessageHuaweiUrgencystring | 华为通道透传消息投递优先级，取值如下：展开详情 示例值:HIGH枚举值:HIGHNORMAL |
AndroidMessageHuaweiCategorystring | |
AndroidMessageOppoCategorystring | OPPO 将消息分类：通讯与服务、内容与营销两个类别进行管理。展开详情 示例值:MARKETING |
AndroidMessageOppoNotifyLevelinteger<int32> | OPPO 通道通知栏消息提醒等级。可取值为：展开详情 示例值:1 |
AndroidMessageVivoCategorystring | vivo 将消息分为：系统消息、运营消息两个类别进行管理。展开详情 示例值:TODO |
AndroidTargetUserTypeinteger<int32> | 设置厂商通道通知类型：展开详情 示例值:0枚举值:01 |
AndroidHuaweiTargetUserTypeinteger<int32> | 设置华为通道通知类型：展开详情 示例值:0枚举值:01 |
AndroidHonorTargetUserTypeinteger<int32> | 设置荣耀通道通知类型：展开详情 示例值:0枚举值:01 |
AndroidVivoPushModeinteger<int32> | 设置 vivo 通道通知类型：展开详情 示例值:0枚举值:01 |
AndroidHuaweiReceiptIdstring | 华为通道回执 ID，该回执 ID 可以在华为通道推送运营平台的回执参数配置中查看。展开详情 示例值:RCP4C123456 |
AndroidVivoReceiptIdstring | vivo 通道回执 ID，该回执 ID 可以在 vivo 开放平台推送服务的应用信息中查看。展开详情 示例值:123 |
AndroidBadgeClassstring | 角标设置应用入口 Activity 的全类名展开详情 示例值:com.alibaba.cloudpushdemo.bizactivity |
AndroidBadgeAddNuminteger<int32> | 设置角标累加值，在原角标的基础上进行累加展开详情 示例值:1取值 <= 99 |
AndroidBadgeSetNuminteger<int32> | 设置角标数字固定值，取值范围[1~99]。展开详情 示例值:5取值 <= 99 |
AndroidMusicstring | 华为厂商通道通知声音。指定存放在客户端项目 app/src/main/res/raw/目录下的音频文件名，不需要携带文件格式后缀名。展开详情 示例值:alicloud_notification_sound |
HarmonyRemindboolean | 推送类型为消息时设备不在线，则这条推送会使用辅助弹窗功能。默认值为 false，仅当 PushType=MESSAGE 时生效。展开详情 示例值:false |
HarmonyRemindTitlestring | Harmony 消息转通知时使用的 Harmony 通知标题，仅当 HarmonyRemind 为 true 时有效。 示例值:新消息 |
HarmonyRemindBodystring | Harmony 消息转通知时使用的 Harmony 通知内容，仅当 HarmonyRemind 为 true 时有效。 示例值:您有一条新消息，请查收 |
HarmonyCategorystring | 通知消息类别。完成申请通知消息自分类权益后，用于标识消息类型，不同的通知消息类型影响消息展示和提醒方式。取值如下：展开详情 示例值:IM枚举值:IMVOIPSUBSCRIPTIONTRAVELHEALTHWORKACCOUNTEXPRESSFINANCEDEVICE_REMINDERMAILCUSTOMER_SERVICEMARKETING |
HarmonyNotificationSlotTypestring | 使用指定类型的通知渠道。仅在阿里云自有通道在线时有效。展开详情 示例值:SOCIAL_COMMUNICATION枚举值:SOCIAL_COMMUNICATIONSERVICE_INFORMATIONCONTENT_INFORMATIONCUSTOMER_SERVICEOTHER_TYPES |
HarmonyNotifyIdinteger<int32> | 每条消息在通知显示时的唯一标识。不携带时，推送服务自动为每条消息生成一个唯一标识；不同的通知消息可以拥有相同的 notifyId，实现新消息覆盖旧消息功能。展开详情 示例值:0 |
HarmonyActionTypestring | 点击通知后动作。可取值：展开详情 示例值:APP_HOME_PAGE枚举值:APP_HOME_PAGEAPP_CUSTOM_PAGE |
HarmonyActionstring | 应用内置页面 ability 对应的 action。展开详情 示例值:com.example.action |
HarmonyUristring | 应用内置页面 ability 对应的 uri。展开详情 示例值:https://www.example.com:8080/push/example |
HarmonyRenderStylestring | 通知消息样式：展开详情 示例值:NORMAL枚举值:NORMALMULTI_LINE |
HarmonyImageUrlstring | 通知右侧大图标 URL，URL 使用的协议必须是 HTTPS 协议。展开详情 示例值:https://example.com/xxx.png |
HarmonyInboxContentstring | 多行文本样式的内容，当 HarmonyRenderStyle 为 MULTI_LINE 时，本字段必填，最多支持 3 条内容。 示例值:["1.content1","2.content2","3.content3"] |
HarmonyExtParametersstring | 设定通知的扩展属性。当推送类型 PushType 设置为 MESSAGE 消息类型时，该属性不生效。展开详情 示例值:{"key1":"value1","api_name":"PushNoticeToAndroidRequest"}
|
HarmonyTestMessageboolean | 测试消息标识：展开详情 示例值:true |
HarmonyReceiptIdstring | 鸿蒙通道回执 ID，该回执 ID 可以在鸿蒙通道推送运营平台的回执参数配置中查看。展开详情 示例值:RCPB***DFD5 |
HarmonyExtensionPushboolean | PushType 为 NOTICE 时，是否为鸿蒙通知扩展消息。展开详情 示例值:true
|
HarmonyExtensionExtraDatastring | 通知扩展消息的额外数据。 示例值:示例额外数据 |
HarmonyBadgeAddNuminteger<int32> | 鸿蒙应用角标累加数字。参考鸿蒙角标 addNum 字段说明。 示例值:1 |
HarmonyBadgeSetNuminteger<int32> | 鸿蒙应用角标设置数字。参考鸿蒙角标 setNum 字段说明。展开详情 示例值:1 |
SmsTemplateNamestring | 补发短信的模板名，可以在短信模板管理界面获取，是系统分配的名称，而非开发者设置的名称。 示例值:短信模板名称 |
SmsSignNamestring | 补发短信的签名。 示例值:短信签名 |
SmsParamsstring | 短信模板的变量名值对，格式： 示例值:key1=value1 |
SmsDelaySecsinteger<int32> | 触发短信的延迟时间，单位：秒。展开详情 示例值:15取值 >= 1 |
SmsSendPolicyinteger<int32> | 触发短信的条件。可取值：展开详情 示例值:0枚举值:01取值 <= 1 |
deprecatedSendSpeedinteger<int32> | 该参数已废弃。 示例值:0取值 >= 10000 |
deprecatedAndroidXiaoMiNotifyTitlestring | 该参数已废弃，所有第三方辅助弹窗都由新参数 AndroidPopupTitle 统一支持。 示例值:无 |
deprecatedAndroidXiaoMiNotifyBodystring | 该参数已废弃，所有第三方辅助弹窗都由新参数 AndroidPopupBody 统一支持。 示例值:无 |
deprecatedAndroidXiaoMiActivitystring | 该参数已废弃，所有第三方辅助弹窗都由新参数 AndroidPopupActivity 统一支持。 示例值:无 |
IdempotentTokenstring | 用于防止 API 调用端重试造成服务端重复推送的一个幂等参数。15 分钟内使用相同 IdempotentToken 进行调用时，只会进行一次推送，后续返回第一次成功推送的结果。展开详情 示例值:c8016d13-6e76-410c-9bda-769383d11787字符长度 <= 36字符长度 >= 36 |
请求说明
请求参数补充说明
Title/Body 展开说明如下：
| 属性\推送类型 | 消息（iOS） | 消息（Android） | 通知（iOS） | 通知（Android） |
|---|---|---|---|---|
| Title | 消息标题，对应消息回调中 CCPSysMessage 的 title 字段 | CPushMessage.title 字段 | 通知标题 | 通知标题，通知回调方法（onNotificationOpened） |
| Body | 消息体，对应消息回调中 CCPSysMessage 的 body 字段 | 消息体，CPushMessage.content 字段 | 通知内容 | 通知内容，通知回调方法（onNotificationOpened） |
下述配置仅作用于 Android 辅助弹窗功能：
推送时设备不在线（既与移动推送的服务端的长连接通道不通），则这条推送可以启动辅助弹窗功能，启动辅助弹窗功能参见移动推送辅助通道配置，且需要具备如下条件：
- 集成第三方辅助通道。
- StoreOffline 参数设为 true。
- 推送通知（无需设置 AndroidRemind）或者推送消息并设置 AndroidRemind 为 true。
- 正确设置 AndroidPopupActivity、AndroidPopupTitle、AndroidPopupBody 参数。
返回参数
| 字段名称 | 字段详情 |
|---|---|
MessageIdstring | 标志一次推送的消息 ID。 示例值:501029 |
RequestIdstring | 请求 ID。 示例值:9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC |