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

push.aliyuncs.com.pushMsg.2015-03-18 (消息推送)

消息推送 ,支持指定用户/账号/广播等模式

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
Account String 可选 username 用户账号列表,以换行区分,仅sendType为3时有效
AntiHarassDuration Number 可选 8 防打扰时长,取值范围为1~23
AntiHarassStartTime Number 可选 22 防打扰开始时间点,取值范围为0~23
AppId Number 必须 10011 应用标识
BatchNumber String 可选 推广活动A 批次编号,用于统计活动推送效果
Body String 必须 你好 消息体,UTF-8编码
DeviceId String 可选 xxxx 设备编号列表,以换行区分,仅sendType为4时有效
DeviceType Number 必须 3 设备类型,取值范围为:0~3云推送支持多种设备, 各种设备类型编号如下:IOS设备:deviceType&1=1; Andriod设备:deviceType&2=2;如果存在此字段,则 向指定的设备类型推送消息。默认为全部(3);
PushTime Date 可选 2015-03-18 11:14:44 推送时间,若空表示立即推送,推送时间不能早于当前 时间
SendType Number 必须 3 推送类型,取值范围:1~4; 1:所有人,无需指定tag、 deviceType等2:一群人,必须指定tag3:指定用户,根 据用户账号列表文件发送消息4:指定设备,根据设备编 码列表文件发送消息默认值为1
Tag String 可选 tag 标签名称,仅支持1个标签,仅sendType为2时有效
Timeout Number 可选 30 离线消息保存时长,取值范围为1~72,若不填,则表 示不保存离线消息
Title String 必须 title 标题

响应参数

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

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
PushAliyuncsComPushMsg2015-03-18Request req = new PushAliyuncsComPushMsg2015-03-18Request();
req.setccount("username");
req.setntiHarassDuration(8L);
req.setntiHarassStartTime(22L);
req.setppId(10011L);
req.setatchNumber("推广活动A");
req.setody("你好");
req.seteviceId("xxxx");
req.seteviceType(3L);
req.setushTime(StringUtils.parseDateTime("2015-03-18 11:14:44"));
req.setendType(3L);
req.setag("tag");
req.setimeout(30L);
req.setitle("title");
PushAliyuncsComPushMsg2015-03-18Response rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<pushMsgResponse>
    <success>true</success>
    <requestId>22123332232332</requestId>
    <responseParams>1040497872727489700</responseParams>
</pushMsgResponse>

异常示例

  • 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>

错误码解释

错误码 错误描述 解决方案
isv.10000 Internal Server Error 服务器内部错误。 客服支持
isv.10001 Method Not Allowed 不允许的操作(指定了错误的HTTP方法或 API)。 查看接口名是否错误
isv.10002 Request Params Not Valid 请求参数非法。 查看请求参数是否合法
isv.10003 Authentication Failed 权限校验错误 。 权限校验失败
isv.10004 Quota Use Up Payment Required 无quota。 Quota Use Up Payment Required 无quota。
isv.10005 Data Required Not Found 请求数据不存在 排查接口
isv.10006 Request Time Expires Timeout 请求已超时。 重试
isv.10008 Duplicate Operation 重复操作。 重复操作。

API工具

如何获得此API

FAQ

返回
顶部