API概览

本文档列举出所有与移动推送服务相关的API接口供您参考,您可以在阿里云OpenAPI 开发者门户上实际体验调用下述接口。

使用前必读:移动推送名词解释与说明

注意

OpenAPI调用频率:500 QPS/IP,具体API限制请参考配额中心

推送相关接口

API

说明

MassPush

批量推送接口,首选。

  • 适用于批量发送单独的通知/消息的场景,如配合生产消费者模式,批量消费,可以极大降低QPS。

Push

推送高级接口(通知/消息均可发送)。

  • 适用于向一个或多个设备发送相同内容的通知/消息。

ContinuouslyPush

持续推送接口。

  • 适用于向大量设备发送同一条消息。

PushMessageToAndroid

推送消息给Android设备。

PushMessageToiOS

推送消息给iOS设备。

PushNoticeToAndroid

推送通知给Android设备。

PushNoticeToiOS

推送通知给iOS设备。

CancelPush

取消尚未执行的定时推送任务。

查询相关接口

API

说明

CheckCertificate

查询证书状态,避免证书过期。

QueryDeviceStat

设备新增与留存。以App为维度,按天统计指定时间段内的新增设备或总设备数量,统计数据为T-1周期的数据。

QueryUniqueDeviceStat

去重设备统计。按天或月维度查询App的去重设备数,统计数据为T-1周期的数据。

QueryDeviceInfo

查询设备详情。

QueryPushStatByAPP

App维度推送统计。按天或小时维度查询App的推送统计信息,统计数据为T-1周期的数据。

QueryPushStatByMsg

任务维度推送统计。根据消息ID查询统计信息,统计数据为T-1天的数据。

CheckDevices

批量检查1~100个设备有效性。

ListPushRecords

查询用户App的推送记录。

TAG相关接口

API

说明

BindTag

绑定TAG。

QueryTags

查询TAG。

UnbindTag

解绑TAG。

RemoveTag

删除TAG。

别名相关接口

API

说明

BindAlias

绑定别名。

UnbindAlias

解绑别名。

QueryDevicesByAlias

通过别名查询设备列表。

QueryAliases

查询别名。

账号相关接口

API

说明

QueryDevicesByAccount

通过账户查询设备列表。

APP相关接口

API

说明

ListSummaryApps

APP概览列表

获取公共参数

获取SDK

Java SDK 可直接使用以下Maven引用。

<dependency> 
<groupId>com.aliyun</groupId> 
<artifactId>aliyun-java-sdk-push</artifactId> 
<version>3.13.7</version> 
</dependency> 
<dependency> 
<groupId>com.aliyun</groupId> 
<artifactId>aliyun-java-sdk-core</artifactId> 
<version>[4.3.2,5.0.0)</version> 
</dependency>
注意

maven官方库更新需要几天时间才能同步,如果maven方式引用失败,请先用上面的git地址下载源码本地编译最新版本jar包。

Demo示例