API概覽
本文檔列舉出所有與移動推送服務(wù)相關(guān)的API接口供您參考,您可以在阿里云OpenAPI 開發(fā)者門戶上實際體驗調(diào)用下述接口。
使用前必讀:基本概念。
API速率限制請參考配額中心。
推送相關(guān)接口
API | 說明 |
批量推送接口(MassPush) | 批量推送接口,首選。
|
推送高級接口(Push) | 推送高級接口(通知/消息均可發(fā)送)。
|
持續(xù)推送接口(ContinuouslyPush) | 持續(xù)推送接口。
|
推消息給Android設(shè)備(PushMessageToAndroid) | 推送消息給Android設(shè)備。 |
推消息給iOS設(shè)備(PushMessageToiOS) | 推送消息給iOS設(shè)備。 |
推通知給Android設(shè)備(PushNoticeToAndroid) | 推送通知給Android設(shè)備。 |
推通知給iOS設(shè)備(PushNoticeToiOS) | 推送通知給iOS設(shè)備。 |
取消定時推送任務(wù)(CancelPush) | 取消尚未執(zhí)行的定時推送任務(wù)。 |
查詢相關(guān)接口
API | 說明 |
查詢證書狀態(tài)(CheckCertificate) | 查詢證書狀態(tài),避免證書過期。 |
設(shè)備新增與留存(QueryDeviceStat) | 設(shè)備新增與留存。以App為維度,按天統(tǒng)計指定時間段內(nèi)的新增設(shè)備或總設(shè)備數(shù)量,統(tǒng)計數(shù)據(jù)為T-1周期的數(shù)據(jù)。 |
去重設(shè)備統(tǒng)計(QueryUniqueDeviceStat) | 去重設(shè)備統(tǒng)計。按天或月維度查詢App的去重設(shè)備數(shù),統(tǒng)計數(shù)據(jù)為T-1周期的數(shù)據(jù)。 |
查詢設(shè)備詳情(QueryDeviceInfo) | 查詢設(shè)備詳情。 |
APP維度推送統(tǒng)計(QueryPushStatByAPP) | App維度推送統(tǒng)計。按天或小時維度查詢App的推送統(tǒng)計信息,統(tǒng)計數(shù)據(jù)為T-1周期的數(shù)據(jù)。 |
任務(wù)維度推送統(tǒng)計(QueryPushStatByMsg) | 任務(wù)維度推送統(tǒng)計。根據(jù)消息ID查詢統(tǒng)計信息,統(tǒng)計數(shù)據(jù)為T-1天的數(shù)據(jù)。 |
批量檢查設(shè)備有效性(CheckDevices) | 批量檢查1~100個設(shè)備有效性。 |
TAG相關(guān)接口
API | 說明 |
綁定TAG(BindTag) | 綁定TAG。 |
查詢TAG(QueryTags) | 查詢TAG。 |
解綁TAG(UnbindTag) | 解綁TAG。 |
刪除TAG(RemoveTag) | 刪除TAG。 |
別名相關(guān)接口
API | 說明 |
綁定別名(BindAlias) | 綁定別名。 |
解綁別名(UnbindAlias) | 解綁別名。 |
通過別名查詢設(shè)備列表(QueryDevicesByAlias) | 通過別名查詢設(shè)備列表。 |
查詢別名(QueryAliases) | 查詢別名。 |
賬號相關(guān)接口
API | 說明 |
通過賬戶查詢設(shè)備列表(QueryDevicesByAccount) | 通過賬戶查詢設(shè)備列表。 |
APP相關(guān)接口
API | 說明 |
ListSummaryApps | APP概覽列表 |
獲取公共參數(shù)
AccessKeyId
和AccessKeySecret
:在阿里云官網(wǎng)控制臺獲取。AppKey
:在 阿里云移動研發(fā)控制臺,進入應(yīng)用管理
頁,在App信息上獲取。
獲取SDK
升級版SDK(推薦)
Java SDK可直接使用以下Maven引用:
<dependency> <groupId>com.aliyun</groupId> <artifactId>push20160801</artifactId> <version>1.0.7</version> </dependency>
原版SDK
Java SDK可直接使用以下Maven引用:
<dependency> <groupId>com.aliyun</groupId> <artifactId>aliyun-java-sdk-push</artifactId> <version>3.13.12</version> </dependency>
maven官方庫更新需要幾天時間才能同步,如果Maven方式引用失敗,請先用上面的Git地址下載源碼本地編譯最新版本jar包。