文档中心 > API类目 > yunos推送服务api

yunos.service.cmns.coa.push (消息推送接口)

调用CMNS系统的pushMessage接口实现消息通知到YUNOS设备的第三方应用软件。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
msg_obj CmnsMessage 必须 消息结构对象
  • └ collapse_key
  • String
  • 可选
  • 12
  • 去重码,1-6位整数,0将视为不填,如果填写则同一appKey相同的去重码消息将会被去重,只保留最新的一条,请谨慎使用
  • └ data
  • String
  • 必须
  • demo
  • 消息内容
  • └ expiration
  • Number
  • 可选
  • 1378585548
  • 消息过期时间,lunix时间戳,单位S,为空或不填时为当前时间的1小时后
  • └ ico
  • String
  • 可选
  • http://example.com/ico.gif
  • 消息图标
  • └ important
  • Number
  • 可选
  • 1
  • 消息是否加密,1:加密,0:不加密
  • └ parameter
  • String
  • 可选
  • {"uri":"http://xx.com"}
  • 消息参数,json字符串格式
  • └ priority
  • Number
  • 可选
  • 1
  • 消息优先权
  • └ program
  • String
  • 必须
  • com.taobao.dim
  • 为action或广播侦听通道,要求填写应用包名(package)
  • receiver
  • Receiver
  • 必须
  • 消息发送对象
  • └ data_list
  • String []
  • 必须
  • ["f6a60db25cd0af09b8e8f11861d038078007a156de5a7e6897bf6c8de2c859638009d4e1aa7d8099dfd90047603e26a2","a750a4542edb909fc4b09793557e0b3ff01b1ffc050120675a80d5be71d8a591e8c760bb5df10107fc67a9536929823f"]
  • deviceToken值,最多1000个
  • └ type
  • String
  • 必须
  • deviceToken
  • 只能填写deviceToken
  • └ responsetype
  • Number
  • 可选
  • 7
  • 响应方式 0:无响应 4:打开应用 7:发送广播
  • └ showtype
  • Number
  • 必须
  • 6
  • 显示方式 1:通知中心 6:后台
  • └ text
  • Number
  • 可选
  • 0
  • 消息是否压缩,0:二进制压缩,1:utf8文本
  • └ title
  • String
  • 必须
  • title
  • 消息标题
  • └ topic
  • String
  • 可选
  • qw
  • 应用订阅主题
  • └ uri
  • String
  • 可选
  • /sas/ssdf.com
  • yunos4.0专用,限制消息只有指定应用来侦听
  • └ deploy_status
  • Number
  • 可选
  • 0
  • 仅IOS应用推送时使用,默认值为0,开发环境为1,生产环境为0

响应参数

名称 类型 示例值 描述
mid Number 12334 消息ID,失败则为null
message String SUCCESS 消息发送提示
status Number 200 200:消息发送成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
YunosServiceCmnsCoaPushRequest req = new YunosServiceCmnsCoaPushRequest();
YunosServiceCmnsCoaPushRequest.CmnsMessage obj1 = new YunosServiceCmnsCoaPushRequest.CmnsMessage();
obj1.setCollapseKey("12");
obj1.setData("demo");
obj1.setExpiration(1378585548L);
obj1.setIco("http://example.com/ico.gif");
obj1.setImportant(1L);
obj1.setParameter("{\"uri\":\"http://xx.com\"}");
obj1.setPriority(1L);
obj1.setProgram("com.taobao.dim");
YunosServiceCmnsCoaPushRequest.Receiver obj2 = new YunosServiceCmnsCoaPushRequest.Receiver();
obj2.setDataList(""f6a60db25cd0af09b8e8f11861d038078007a156de5a7e6897bf6c8de2c859638009d4e1aa7d8099dfd90047603e26a2","a750a4542edb909fc4b09793557e0b3ff01b1ffc050120675a80d5be71d8a591e8c760bb5df10107fc67a9536929823f"");
obj2.setType("deviceToken");
obj1.setReceiver(obj2);
obj1.setResponsetype(7L);
obj1.setShowtype(6L);
obj1.setText(0L);
obj1.setTitle("title");
obj1.setTopic("qw");
obj1.setUri("/sas/ssdf.com");
obj1.setDeployStatus(0L);
req.setMsgObj(obj1);
YunosServiceCmnsCoaPushResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<yunos_service_cmns_coa_push_response>
    <mid>12334</mid>
    <message>SUCCESS</message>
    <status>200</status>
</yunos_service_cmns_coa_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

返回
顶部