API overview-阿里云帮助中心

This document lists all API operations for the Mobile Push service. You can test these operations in the Alibaba Cloud OpenAPI Developer Portal.

Before you begin, see Basic Concepts.

Important

For information about API rate limits, see Quota Center.

Push-related API operations

API	Description
Mass Push API (MassPush)	The batch push API operation. This is the recommended operation. Use this operation to send individual notifications or messages in batches. For example, you can use this operation with a producer-consumer pattern for batch consumption to significantly reduce queries per second (QPS).
Advanced Push API (Push)	The advanced push API operation. You can send both notifications and messages. Use this operation to send notifications or messages with the same content to one or more devices.
Continuously Push	The continuous push API operation. Use this operation to send the same message to many devices.
Push a message to an Android device (PushMessageToAndroid)	Sends a message to Android devices.
PushMessageToiOS	Sends a message to iOS devices.
PushNoticeToAndroid	Sends a notification to Android devices.
Send a notification to an iOS device (PushNoticeToiOS)	Sends a notification to iOS devices.
CancelPush	Cancels a scheduled push task that has not been executed.

Query-related API operations

API	Description
CheckCertificate	Queries the status of a certificate to prevent it from expiring.
Device growth and retention (QueryDeviceStat)	Queries statistics on new and retained devices. This operation collects daily statistics on the number of new or total devices for an application over a specified period. The statistics are from the previous day (T-1).
Unique Device Statistics (QueryUniqueDeviceStat)	Queries statistics on deduplicated devices. This operation queries the number of deduplicated devices for an application by day or month. The statistics are from the previous day (T-1).
QueryDeviceInfo	Queries the details of a device.
Query push statistics by app (QueryPushStatByApp)	Queries push statistics for an application. This operation queries push statistics for an application by day or hour. The statistics are from the previous day (T-1).
Query push statistics by task (QueryPushStatByMsg)	Queries push statistics for a task. This operation queries statistics based on a message ID. The statistics are from the previous day (T-1).
CheckDevices	Checks the validity of 1 to 100 devices in a batch.

Tag-related API operations

API	Description
BindTag	Attaches a tag.
QueryTags	Queries tags.
UnbindTag	Detaches a tag.
RemoveTag	Deletes a tag.

Alias-related API operations

API	Description
BindAlias	Attaches an alias.
UnbindAlias	Detaches an alias.
Querying devices by alias (QueryDevicesByAlias)	Queries a list of devices by alias.
QueryAliases	Queries aliases.

Account-related API operations

API	Description
QueryDevicesByAccount	Queries a list of devices by account.

Application-related API operations

API	Description
ListSummaryApps	App Overview

Get common parameters

AccessKeyId and AccessKeySecret: Obtain them from the Alibaba Cloud console.
AppKey: In the Alibaba Cloud Mobile Emas console, go to the Application Management page and find the AppKey in the application information.

Get the SDK

Upgraded SDK (Recommended)
(TeaDSL) Node.js
(TeaDSL) PHP
(TeaDSL) Go
(TeaDSL) Java
(TeaDSL) C#
(TeaDSL) Python 3
(TeaDSL) C++
Java SDK: Use the following Maven reference:
```
<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>push20160801</artifactId>
  <version>1.0.7</version>
</dependency>
```
Original SDK
aliyun-java-sdk-push
aliyun-net-sdk-push
aliyun-nodejs-sdk-push
aliyun-php-sdk-push
aliyun-python-sdk-push
aliyun-cpp-sdk-push
aliyun-go-sdk-push
Java SDK: Use the following Maven reference:
```
<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>aliyun-java-sdk-push</artifactId>
  <version>3.13.12</version>
</dependency>
```