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

yunos.ospush.open.notify.push.pubtag (指定标签发送通知消息接口)

该接口使用OS公共标签圈定人群,然后向该人群发送通知消息。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
session_id String 必须 DX1234
  • 最大长度:64
  • 自定义随机字符串,用以标识本次调用。每次调用值不要相同
    task_info TaskInfo 必须 taskInfo对象
    • └ task_name
    • String
    • 可选
    • taskName
    • 本次调用任务名称,如果不传,系统会自动命名
    tag_condition_lists TagCondition [] 必须
  • 最大列表长度:20
  • 用户标签列表,注意:1、此列表List的总数不允许超过20个。2、tagValues的总数不能超过30个
    • └ tag_code
    • String
    • 必须
    • test_tag
    • 标签Code。 注意:我们提供了测试标签供ISV测试。 但是需要提前联系管理员,把你手机的imei/deviceToken告诉我们,我们将其和测试标签做绑定后,ISV就可以将数据发送到测试的设备上。 测试标签填写样式:[{"tag_values":"test_tag","tag_code":"test_tag"}]
    • └ tag_values
    • String
    • 必须
    • test_tag
    • 1、checkbox类型:多值用逗号分隔。比如"男,女" 2、date类型:小值在前,大值在后,用逗号分隔。比如"2016-05-01,2016-10-01" 3、number类型:小值在前,大值在后,用逗号分隔。比如"1,10"表示大于等于1,小于等于10;"1,"表示大于等于1;",10"表示小于等于10
    message PushMessage 必须 发送的消息信息
    • └ msg_title
    • String
    • 必须
    • 主标题
    • 通知中心主标题
    • └ msg_sub_title
    • String
    • 必须
    • 副标题
    • 通知中心副标题
    • └ msg_content
    • String
    • 可选
    • 通知消息体
    • json格式 1、打开应用(无需传值) 3、打开uri: {"uri": "xiami://collect/11332531"}
    • └ validity_hour
    • Number
    • 必须
    • 5
    • 多长时间消息失效,单位是小时
    • └ msg_type
    • Number
    • 必须
    • 1
    • 通知消息类型 1:打开应用, 3:打开uri,
    • └ page_link
    • String
    • 可选
    • Main
    • CLOUDAPP应用接收push消息的pageLink,最终page格式为 page://domain/pageLink, domain从应用信息里获取,用户只需要输入pageLink值即可
    cond_map Json 可选 {} 备用参数,约定为Map类型,暂时不启用

    响应参数

    名称 类型 示例值 描述
    result TopResult result
    • model
    • PushTaskResult
    • model
    • └ session_id
    • String
    • DX1234
    • ISV传入的sessionId,用以标识本次调用
    • └ task_id
    • Number
    • 1234
    • taskId
    • └ task_type
    • Number
    • 1
    • taskType
    • └ code
    • String
    • 10000
    • 当code为10000时,才表示调用成功
    • └ msg
    • String
    • 操作成功
    • msg

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    YunosOspushOpenNotifyPushPubtagRequest req = new YunosOspushOpenNotifyPushPubtagRequest();
    req.setSessionId("DX1234");
    YunosOspushOpenNotifyPushPubtagRequest.TaskInfo obj1 = new YunosOspushOpenNotifyPushPubtagRequest.TaskInfo();
    obj1.setTaskName("taskName");
    req.setTaskInfo(obj1);
    List<YunosOspushOpenNotifyPushPubtagRequest.TagCondition> list3 = new ArrayList<YunosOspushOpenNotifyPushPubtagRequest.TagCondition>();
    YunosOspushOpenNotifyPushPubtagRequest.TagCondition obj4 = new YunosOspushOpenNotifyPushPubtagRequest.TagCondition();
    list3.add(obj4);
    obj4.setTagCode("test_tag");
    obj4.setTagValues("test_tag");
    req.setTagConditionLists(list3);
    YunosOspushOpenNotifyPushPubtagRequest.PushMessage obj5 = new YunosOspushOpenNotifyPushPubtagRequest.PushMessage();
    obj5.setMsgTitle("主标题");
    obj5.setMsgSubTitle("副标题");
    obj5.setMsgContent("通知消息体");
    obj5.setValidityHour(5L);
    obj5.setMsgType(1L);
    obj5.setPageLink("Main");
    req.setMessage(obj5);
    req.setCondMapString("{}");
    YunosOspushOpenNotifyPushPubtagResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <yunos_ospush_open_notify_push_pubtag_response>
        <result>
            <model>
                <session_id>DX1234</session_id>
                <task_id>1234</task_id>
                <task_type>1</task_type>
            </model>
            <code>10000</code>
            <msg>操作成功</msg>
        </result>
    </yunos_ospush_open_notify_push_pubtag_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>

    错误码解释

    错误码 错误描述 解决方案
    isv.10020 push渠道非法 请检查自己的appkey是否被授权
    isv.10100 入参参数非法 返回的msg中有错误的明细信息,请对照
    isv.11010 创建push推送失败 创建push推送失败。可以联系管理员排查问题
    isv.11020 人群条件选择错误 人群条件选择错误,请检查是否是自己可以使用的人群标签
    isv.11021 添加人群失败 添加人群失败,可以联系管理员排查问题
    isv.11022 用户非法 用户非法
    isv.11023 program对象未配置 请联系管理员检查应用的配置
    isv.12040 新建任务失败 新建任务失败,请检查msg_content是否为json格式,或联系管理员排查问题
    isv.12050 测试标签tagValues不正确 测试标签tagValues不正确 请检查标签入参是否满足如下配置: [{"tag_values":"test_tag","tag_code":"test_tag"}]
    isv.10090 您的文案中有敏感词 您的文案中有敏感词
    isv.10080 您调用的太频繁了 您调用的太频繁了
    isv.10081 您今天的调用总量已超过限制 您今天的调用总量已超过限制
    isv.11025 请至少设置一个私有标签 请至少设置一个私有标签

    API工具

    如何获得此API

    FAQ

    返回
    顶部