API概览

更新时间:
复制为 MD 格式

本产品(Push/2016-08-01)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

推送相关接口

API

标题

API概述

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

查询相关接口

API

标题

API概述

CheckCertificate 查询证书状态 检测指定appiOS证书过期时间及当前证书状态。
QueryPushRecords 查询推送记录 分页查询推送记录,并提供一些简单的筛选能力。
QueryDeviceStat 设备新增与留存 查询app维度的设备统计。
QueryUniqueDeviceStat 去重设备统计 查询app维度的去重设备统计。
QueryDeviceInfo 查询设备详情 查询指定设备详细信息。
QueryPushStatByApp App维度推送统计 查询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的列表。