API概览

API标准及多语言预置SDK

本产品(移动推送/2016-08-01)的 OpenAPI 采用 RPC 签名机制,具体签名方式请参见签名机制说明我们已为开发者封装了主流编程语言的 SDK,您可通过 下载 SDK 快速调用 API,无需关注签名等底层实现细节,显著降低开发门槛与集成复杂度。

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的 RAM 用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

推送相关接口

API标题API概述
Push高级推送高级推送接口,推送通知或者消息到不同设备端,本接口提供丰富的推送定制参数,以实现不同场景下的推送行为。
MassPush批量推送批量给不同的设备推送不同的消息/通知。
ContinuouslyPush持续推送执行预定义的持续推送任务。
CompleteContinuouslyPush完成持续推送任务手动结束持续推送任务。
CancelPush取消定时推送任务取消某次尚未执行的定时推送任务。
PushV2高级推送高级推送接口V2。
MassPushV2批量推送高级推送接口V2。

查询相关接口

API标题API概述
CheckCertificate查询证书状态检测指定appiOS证书过期时间及当前证书状态。
QueryPushRecords查询推送记录分页查询推送记录,并提供一些简单的筛选能力。
QueryDeviceStat设备新增与留存查询app维度的设备统计。
QueryUniqueDeviceStat去重设备统计查询app维度的去重设备统计。
QueryDeviceInfo查询设备详情查询指定设备详细信息。
QueryPushStatByAppApp维度推送统计查询app维度的推送统计。
QueryPushStatByMsg任务维度推送统计查询消息维度的推送统计。
CheckDevices批量检查设备有效性验证指定的一组设备的有效性。

标签相关接口

API标题API概述
BindTag绑定标签TAG绑定到指定的目标(设备、账号或别名),TAG绑定在10分钟内生效。
UnbindTag解绑标签解绑指定的TAG和其目标之间的关系。
RemoveTag删除标签删除app下的TAG。
QueryTags查询标签列表查询指定对象(设备、账号或别名)的TAG列表。
ListTags获取标签列表查询app的标签列表,最多返回100条记录。

别名相关接口

API标题API概述
BindAlias绑定别名绑定设备和别名的关系。
UnbindAlias解绑别名解绑别名,解绑立即生效。
QueryAliases查询别名查询指定设备绑定的别名列表。
QueryDevicesByAlias通过别名查询设备列表通过别名查询对应的设备列表。

账号相关接口

API标题API概述
QueryDevicesByAccount通过账户查询设备列表通过账户名称查询对应的设备列表。

其他接口

API标题API概述
BindPhone绑定手机号码绑定设备与手机号的关系。
UnbindPhone解绑手机号码解绑指定设备上已绑定的手机号码。

后续下线接口(不建议使用)

API标题API概述
PushMessageToiOS推送消息给iOS设备推送消息到iOS设备端,消息通过阿里云推送自有通道下发。设备上App接收到消息后,需要自行处理后续动作,比如实现业务行为,或者构造本地通知弹出等。
PushNoticeToiOS推送通知给iOS设备推送通知到 iOS 设备端,通知通过苹果APNs通道下发,并直接在设备通知栏弹出。
PushNoticeToAndroid推送通知给Android设备推送通知到Android设备端,并直接在设备通知栏弹出。通知根据不同情况,可能会走阿里云自有通道,或者手机厂商通道下发。
PushMessageToAndroid推送消息给Android设备推送消息到Android设备端,消息通过阿里云推送自有通道下发。设备上App接收到消息后,需要自行处理后续动作,比如实现业务行为,或者构造本地通知弹出等。
CheckDevice验证设备有效性验证指定设备的有效性。
ListSummaryApps查询用户已创建的app列表查询云账号下所有app的列表。