文档中心 > API类目 > 百川基础能力(新)

taobao.cloudpush.push (百川用户使用云推送高级推送接口)

百川用户使用云推送高级推送接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
target String 必须 device 推送目标: device:推送给设备; account:推送给指定帐号,tag:推送给自定义标签; all: 推送给全部
target_value String 必须 device1,device2 根据Target来设定,如Target=device, 则对应的值为 设备id1,设备id2. 多个值使用逗号分隔.(帐号与设备有一次最多100个的限制)
android_activity String 可选 /store/... Android对应的activity,仅仅当androidOpenType=2有效
android_ext_parameters String 可选 {"k":"v"} 自定义的kv结构,开发者扩展用 针对android
android_music String 可选 default android通知声音
android_open_type String 可选 1 点击通知后动作,1:打开应用 2: 打开应用Activity 3:打开 url
android_open_url String 可选 http://www.taobao.com Android收到推送后打开对应的url,仅仅当androidOpenType=3有效
anti_harass_duration Number 可选 13 防打扰时长,取值范围为1~23
anti_harass_start_time Number 可选 1 防打扰开始时间点,取值范围为0~23
batch_number String 可选 0001 批次编号,用于活动效果统计
body String 必须 this is push body 推送内容
device_type Number 必须 3 设备类型,取值范围为:0~3云推送支持多种设备,各种设备类型编号如下: iOS设备:deviceType=0; Andriod设备:deviceType=1;如果存在此字段,则向指定的设备类型推送消息。 默认为全部(3);
ios_badge String 可选 1 iOS应用图标右上角角标
ios_ext_parameters String 可选 {"k":"v"} 自定义的kv结构,开发者扩展用 针对iOS设备
ios_music String 可选 default iOS通知声音
remind Boolean 必须 false 当APP不在线时候,是否通过通知提醒. 针对不同设备,处理逻辑不同。 该参数只针对iOS设备生效, (remind=true & 发送消息的话(type=0)). 当你的目标设备不在线(既长连接通道不通, 我们会将这条消息的标题,通过苹果的apns通道再送达一次。发apns是发送生产环境的apns,需要在云推送配置的app的iOS生产证书和密码需要正确,否则也发送不了。 (remind=false & 并且是发送消息的话(type=0)),那么设备不在线,则不会再走苹果apns发送了。
store_offline Boolean 必须 false 离线消息是否保存,若保存, 在推送时候,用户即使不在线,下一次上线则会收到
summery String 可选 this is summary 通知的摘要
timeout Number 可选 72 离线消息保存时长,取值范围为1~72,若不填,则表示不保存离线消息
title String 必须 this is title 推送的标题内容.
type Number 可选 0 0:表示消息(默认为0),1:表示通知

响应参数

名称 类型 示例值 描述
is_success Boolean false 请求是否成功
request_error_code Number 10003 请求失败对应的错误代码.
request_error_msg String service fail 请求失败的错误信息.

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CloudpushPushRequest req = new CloudpushPushRequest();
req.setTarget("device");
req.setTargetValue("device1,device2");
req.setAndroidActivity("/store/...");
req.setAndroidExtParameters("{\"k\":\"v\"}");
req.setAndroidMusic("default");
req.setAndroidOpenType("1");
req.setAndroidOpenUrl("http://www.taobao.com");
req.setAntiHarassDuration(13L);
req.setAntiHarassStartTime(1L);
req.setBatchNumber("0001");
req.setBody("this is push body");
req.setDeviceType(3L);
req.setIosBadge("1");
req.setIosExtParameters("{\"k\":\"v\"}");
req.setIosMusic("default");
req.setRemind(false);
req.setStoreOffline(false);
req.setSummery("this is summary");
req.setTimeout(72L);
req.setTitle("this is title");
req.setType(0L);
CloudpushPushResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cloudpush_push_response>
    <is_success>false</is_success>
    <request_error_code>10003</request_error_code>
    <request_error_msg>service fail</request_error_msg>
</cloudpush_push_response>

异常示例

  • 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

返回
顶部