注意:以下文档只适用于TOP接口,请谨慎使用!

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

push.aliyuncs.com.pushNotification.2015-03-18 (推送通知)

pushNotification

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
Account String 可选 username 用户账号列表,以换行区分,仅sendType为3时有效
AndroidExtraMap String 可选 {"k":"v"} 自定义的kv结构,开发者扩展用
AndroidMusic String 可选 default 通知声音
AndroidNotifyType Number 可选 1 通知类型 1:震动 2:响铃
AndroidOpenActivity String 可选 /store/... 打开app指定位置
AndroidOpenType Number 可选 1 点击通知后动作
AndroidOpenUrl String 可选 com.xxx.xx 打开应用,网页
AntiHarassDuration Number 可选 8 防打扰时长,取值范围为1~23
AntiHarassStartTime Number 可选 22 防打扰开始时间点,取值范围为0~23
AppId Number 必须 10011 应用标识
BatchNumber String 可选 活动A 批次编号,用于活动效果统计
DeviceId String 可选 xxxx 设备编号列表,以换行区分,仅sendType为4时有效
DeviceType Number 必须 1 设备类型,取值范围为:0~3云推送支持多种设备,各 种设备类型编号如下:IOS设备:deviceType&1=1; Andriod设备:deviceType&2=2;如果存在此字段,则向 指定的设备类型推送消息。默认为全部(3);
IosExtraMap String 可选 {"k":"v"} 自定义的kv结构,开发者扩展用
IosFooter Number 可选 2 角标
IosMusic String 可选 default 默认音乐
PushTime Date 可选 2015-03-18 18:00:00 推送时间,若空表示立即推送,推送时间不能早于当前时间
SendType Number 必须 2 推送类型,取值范围:1~4; 1:所有人,无需指定tag、 deviceType等2:一群人,必须指定tag3:指定用户,根据 用户账号列表文件发送消息4:指定设备,根据设备编码列 表文件发送消息默认值为1
Summary String 必须 你收到.... 摘要
Tag String 可选 tag 标签名称,仅支持1个标签,仅sendType为2时有效
Timeout Number 可选 36 离线消息保存时长,取值范围为1~72,若不填,则表示不保存离线消息
Title String 必须 title 标题

响应参数

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

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
PushAliyuncsComPushNotification2015-03-18Request req = new PushAliyuncsComPushNotification2015-03-18Request();
req.setccount("username");
req.setndroidExtraMap("{\"k\":\"v\"}");
req.setndroidMusic("default");
req.setndroidNotifyType(1L);
req.setndroidOpenActivity("/store/...");
req.setndroidOpenType(1L);
req.setndroidOpenUrl("com.xxx.xx");
req.setntiHarassDuration(8L);
req.setntiHarassStartTime(22L);
req.setppId(10011L);
req.setatchNumber("活动A");
req.seteviceId("xxxx");
req.seteviceType(1L);
req.setosExtraMap("{\"k\":\"v\"}");
req.setosFooter(2L);
req.setosMusic("default");
req.setushTime(StringUtils.parseDateTime("2015-03-18 18:00:00"));
req.setendType(2L);
req.setummary("你收到....");
req.setag("tag");
req.setimeout(36L);
req.setitle("title");
PushAliyuncsComPushNotification2015-03-18Response rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<pushNotificationResponse>
    <success>true</success>
    <requestId>1040497872727489700</requestId>
    <responseParams>23233232332</responseParams>
</pushNotificationResponse>

异常示例

  • 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

返回
顶部