文档中心 > API类目 > 阿里云API

push.aliyuncs.com.push.20150518 (云推送指令API)

阿里云推送新增API,允许一条推送指令同时发布到多个终端上。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
Account String 可选 acount1,account2 用户账号列表,以换行区分,仅sendType为3时有效
AndroidActivity String 可选 /store/... Android对应的activity,仅仅当androidOpenType=2有效
AndroidExtParameters String 可选 {"k":"v"} 自定义的kv结构,开发者扩展用 针对android
AndroidMusic String 可选 default android通知声音
AndroidOpenType String 可选 1 点击通知后动作,1:打开应用 2: 打开应用Activity 3:打开 url
AndroidOpenUrl String 可选 http://www.taobao.com Android收到推送后打开对应的url,仅仅当androidOpenType=3有效
AntiHarassDuration Number 可选 1 防打扰时长,取值范围为1~23
AntiHarassStartTime Number 可选 12 防打扰开始时间点,取值范围为0~23
AppId Number 必须 10011 应用标识
BatchNumber String 可选 BatchNumberA 批次编号,用于活动效果统计
Body String 必须 this is push body... 推送内容
DeviceId String 可选 device1,device2 推送接收设备,多个以逗号分隔
DeviceType Number 必须 3 设备类型,取值范围为:0~3云推送支持多种设备,各 种设备类型编号如下: 0:IOS设备; 1:Andriod设备 3:全部. 默认为3.
IOSBadge String 可选 2 iOS应用图标右上角角标
IOSExtParameters String 可选 {"k":"v"} 自定义的kv结构,开发者扩展用 针对iOS设备
IOSMusic String 可选 default iOS通知声音
PushTime Date 可选 2015-03-18 18:00:00 推送时间,若空表示立即推送,推送时间不能早于当前时间
Remind Boolean 必须 false 当APP不在线时候,是否通过通知提醒
SendType Number 必须 4 推送类型,取值范围:1~4; 1:所有人,无需指定tag、 deviceType等2:一群人,必须指定tag3:指定用户,根据 用户账号列表文件发送消息4:指定设备,根据设备编码列 表文件发送消息默认值为1
StoreOffline Boolean 必须 false 离线消息是否保存,若保存, 在推送时候,用户即使不在线,下一次上线则会收到
Summery String 可选 this is summary 通知的摘要
Timeout Number 可选 2 离线消息保存时长,取值范围为1~72,若不填,则表示不保存离线消息
Title String 必须 this is title 推送的标题内容.

响应参数

名称 类型 示例值 描述
responseParams String 100001 消息ID,用于查询
success Boolean true 是否成功
requestId Number 1040497872727489700 该字段的值由服务端生成,返回给用户方便问题追查与定位。

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
PushAliyuncsComPush20150518Request req = new PushAliyuncsComPush20150518Request();
req.setccount("acount1,account2");
req.setndroidActivity("/store/...");
req.setndroidExtParameters("{\"k\":\"v\"}");
req.setndroidMusic("default");
req.setndroidOpenType("1");
req.setndroidOpenUrl("http://www.taobao.com");
req.setntiHarassDuration(1L);
req.setntiHarassStartTime(12L);
req.setppId(10011L);
req.setatchNumber("BatchNumberA");
req.setody("this is push body...");
req.seteviceId("device1,device2");
req.seteviceType(3L);
req.setOSBadge("2");
req.setOSExtParameters("{\"k\":\"v\"}");
req.setOSMusic("default");
req.setrovinceId("10011");
req.setushTime(StringUtils.parseDateTime("2015-03-18 18:00:00"));
req.setemind(false);
req.setendType(4L);
req.settatus(1L);
req.settoreOffline(false);
req.setummery("this is summary");
req.setimeout(2L);
req.setitle("this is title");
req.setype(0L);
PushAliyuncsComPush20150518Response rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<pushResponse>
    <responseParams>100001</responseParams>
    <success>true</success>
    <requestId>1040497872727489700</requestId>
</pushResponse>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部