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

yunos.ospush.open.notify.push (发送通知中心消息)

开发者可以使用此API发送通知中心消息

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
task_name String 必须 testTask 任务名称
user_group String 可选 male,female 发送目标人群描述
device_tokens String 必须 123415,23423 设备标示,多个用英文逗号分隔,最多500个
token_type Number 必须 2 1-device_token,2-imei,3-uuid
msg_id String 必须 DWEADCCTADDX 发送消息的唯一ID,相同的信息msgId需一致
msg_title String 必须 标题 通知中心显示标题
msg_content String 必须 内容 通知中心显示内容
msg_parameter String 必须 {"uri":"XXXX"} 参数详情,细节请和管理员联系
channel String 必须 NORMAL 通道级别
expire_time Number 必须 3600 消息失效时间,精确到秒
attachment String 必须 attachment
  • 最大长度:128
  • 透传字段,会在返回结果中返回
    session_id String 必须 DU5738CSDF
  • 最大长度:128
  • 随机字符串,用以标识本次调用

    响应参数

    名称 类型 示例值 描述
    result TopResult result result
    • model
    • PushResult
    • model
    • model
    • └ task_id
    • String
    • taskId
    • taskId
    • └ attachment
    • String
    • attachment
    • attachment
    • └ limited_tokens
    • String
    • limitedTokens
    • limitedTokens,逗号分隔
    • └ failed_tokens
    • String
    • {}
    • json格式,使用kv结构。如果没有错误token,样式为"failedTokens":"{}";如果有错误token,样式为"failedTokens":"{\"errorToken\":\"72348\"}" 。failed_tokens会根据不同的场景返回不同的key值,请做好解析。
    • └ code
    • String
    • code
    • code
    • └ msg
    • String
    • msg
    • msg

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    YunosOspushOpenNotifyPushRequest req = new YunosOspushOpenNotifyPushRequest();
    req.setTaskName("testTask");
    req.setUserGroup("male,female");
    req.setDeviceTokens("123415,23423");
    req.setTokenType(2L);
    req.setMsgId("DWEADCCTADDX");
    req.setMsgTitle("标题");
    req.setMsgContent("内容");
    req.setMsgParameter("{\"uri\":\"XXXX\"}");
    req.setChannel("NORMAL");
    req.setExpireTime(3600L);
    req.setAttachment("attachment");
    req.setSessionId("DU5738CSDF");
    YunosOspushOpenNotifyPushResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <yunos_ospush_open_notify_push_response>
        <result>
            <model>
                <task_id>taskId</task_id>
                <attachment>attachment</attachment>
                <limited_tokens>limitedTokens</limited_tokens>
                <failed_tokens>{}</failed_tokens>
            </model>
            <code>code</code>
            <msg>msg</msg>
        </result>
    </yunos_ospush_open_notify_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>

    错误码解释

    错误码 错误描述 解决方案
    isp.10010 push任务失败 检查参数和内容
    isp.10020 push渠道非法 检查参数
    isp.10021 push渠道级别非法 检查参数
    isp.10030 不在被允许发送的时间范围内 检查时间参数
    isp.10040 超出单次接口调用发送人数限制(500) 单次调用的device_tokens数量太多
    isp.10041 limitedTokens标识哪些设备超出单日发送限制; failedTokens标识哪些设备处理失败 检查参数或联系管理员
    isp.10050 tokenType非法 检查参数
    isp.10060 msgParameter格式错误 检查参数
    isp.10042 没有发送设备信息 device_tokens参数为空
    isp.10070 sessionId不允许为空,或者传入长度超过限制 sessionId不允许为空,或者传入长度超过限制
    isp.10080 您调用的太频繁了 您调用的太频繁了
    isp.10090 您的文案中有敏感词 请检查文案
    isv.10020 push渠道非法 检查参数
    isv.10021 push渠道级别非法 检查参数
    isv.10030 不在被允许发送的时间范围内 检查时间参数
    isv.10040 超出单次接口调用发送人数限制(500) 单次调用的device_tokens数量太多
    isv.10041 limitedTokens标识哪些设备超出单日发送限制; failedTokens标识哪些设备处理失败 检查参数或联系管理员
    isv.10050 tokenType非法 检查参数
    isv.10060 msgParameter格式错误 检查参数
    isv.10042 没有发送设备信息 device_tokens参数为空
    isv.10070 sessionId不允许为空,或者传入长度超过限制 sessionId不允许为空,或者传入长度超过限制
    isv.10080 您调用的太频繁了 您调用的太频繁了
    isv.10090 您的文案中有敏感词 请检查文案

    API工具

    如何获得此API

    FAQ

    返回
    顶部