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

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

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

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
push_request PushRequest 必须 消息推送请求对象
  • └ device_type
  • Number
  • 可选
  • 1
  • 设备类型,1:android or yunos,2:ios,当deviceType不指定时,服务器端对msg json字段按照android格式解析
  • └ expiration
  • Number
  • 可选
  • 7200
  • 默认值:3600
  • 消息过期时间,相对时间(即多少秒后过期,最多7天),单位S,不填默认1小时过期
  • └ ios_environment
  • Number
  • 可选
  • 0
  • 默认值:0
  • 仅IOS应用推送时使用,0代表生成环境,1代表沙箱环境,默认值为0
  • └ msg
  • String
  • 必须
  • {"action":"com.yunos.cmns","customContent":"{\"from\":\"http://baidu.com\",\"result\":\"success\"}","desc":"this is a desc","pkgContent":"{\"uri\":\"http://taobao.com\",\"package\":\"com.yunos.cmns\"}","title":"this is title"}
  • 消息内容, 为json字符串,格式详见http://open.yunos.com/doc/detail?spm=a2c01.7698725.0002.40.ZNPFOJ&documentId=102975
  • receiver
  • Receiver
  • 必须
  • 消息发送对象
  • └ data
  • String []
  • 必须
  • ["f6a60db25cd0af09b8e8f11861d038078007a156de5a7e6897bf6c8de2c859638009d4e1aa7d8099dfd90047603e26a2","a750a4542edb909fc4b09793557e0b3ff01b1ffc050120675a80d5be71d8a591e8c760bb5df10107fc67a9536929823f"]
  • deviceToken值,最多1000个
  • └ type
  • String
  • 必须
  • deviceToken
  • 只能填写deviceToken
  • └ type
  • Number
  • 必须
  • 1
  • 消息类型,当前type只能取1,即只能发送给应用透传消息
  • └ priority
  • Number
  • 可选
  • 3
  • 默认值:2
  • 消息发送优先级,范围为1-5,数字越高,优先级越大,不设置默认优先级为2
  • └ biz_app_key
  • String
  • 可选
  • 23714768
  • 业务应用appKey,top调用不需要传此参数
  • └ collapse_key
  • String
  • 可选
  • 14978300457
  • 去重码,为应用自己维护的消息唯一标记

响应参数

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

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
YunosServiceCmnsCoaMessagePushRequest req = new YunosServiceCmnsCoaMessagePushRequest();
YunosServiceCmnsCoaMessagePushRequest.PushRequest obj1 = new YunosServiceCmnsCoaMessagePushRequest.PushRequest();
obj1.setDeviceType(1L);
obj1.setExpiration(7200L);
obj1.setIosEnvironment(0L);
obj1.setMsg("{\"action\":\"com.yunos.cmns\",\"customContent\":\"{\\"from\\":\\"http://baidu.com\\",\\"result\\":\\"success\\"}\",\"desc\":\"this is a desc\",\"pkgContent\":\"{\\"uri\\":\\"http://taobao.com\\",\\"package\\":\\"com.yunos.cmns\\"}\",\"title\":\"this is title\"}");
YunosServiceCmnsCoaMessagePushRequest.Receiver obj2 = new YunosServiceCmnsCoaMessagePushRequest.Receiver();
obj2.setData(""f6a60db25cd0af09b8e8f11861d038078007a156de5a7e6897bf6c8de2c859638009d4e1aa7d8099dfd90047603e26a2","a750a4542edb909fc4b09793557e0b3ff01b1ffc050120675a80d5be71d8a591e8c760bb5df10107fc67a9536929823f"");
obj2.setType("deviceToken");
obj1.setReceiver(obj2);
obj1.setType(1L);
obj1.setPriority(3L);
obj1.setBizAppKey("23714768");
obj1.setCollapseKey("14978300457");
req.setPushRequest(obj1);
YunosServiceCmnsCoaMessagePushResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<yunos_service_cmns_coa_message_push_response>
    <mid>1234</mid>
    <message>SUCCESS</message>
    <status>200</status>
</yunos_service_cmns_coa_message_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

返回
顶部