文档

API概览

更新时间:
本产品(移动推送/2016-08-01)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

推送相关接口

API标题API概述
MassPush批量推送批量给不同的设备推送不同的消息/通知。
Push高级推送高级推送接口,提供丰富的推送定制参数。
ContinuouslyPush持续推送执行预定义的持续推送任务。
CompleteContinuouslyPush完成持续推送任务手动结束持续推送任务。
CancelPush取消定时推送任务取消某次尚未执行的定时推送任务。
PushMessageToAndroid推送消息给Android设备推送消息给Android设备。
PushMessageToiOS推送消息给iOS设备推送消息给iOS设备。
PushNoticeToAndroid推送通知给Android设备推送通知给Android设备,本接口仅通过阿里云自有通道进行推送。
PushNoticeToiOS推送通知给iOS设备推送通知给iOS设备,iOS设备需要处于在线状态。

查询相关接口

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

标签相关接口

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解绑手机号码解绑指定设备上已绑定的手机号码。
ListSummaryApps查询用户已创建的app列表查询云账号下所有app的列表。