文档中心 > API类目 > 淘宝客API

taobao.tbk.marketing.msg.send (商业化消息推送)

商业化消息推送

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
func_type Number 必须 1
  • 默认值:0
  • 功能类型,0-测试 1-推送
    msg_id String 可选 h7a9dht4l 单次消息推送唯一标识
    material_type Number 可选 1
  • 默认值:1
  • 物料类型,1-单品,2-活动会场,3-动态承接页,默认为1
    template_id Number 可选 7989 小二提供或素材库下载的模板ID
    material_id String 可选 mda76h9fa7-7dbaliu4q 推送物料ID,与物料类型一一对应,如类型为单品时,请传入新商品ID
    uvid String 可选 jo3iha09fn7ed 用户标识
    adzone_id String 必须 123 pid三段式的第三段
    start_time String 可选 2023-11-11 00:00:00 计划发送时间,格式为:yyyy-mm-dd hh:mm:ss
    test_oaid String 可选 OAID 测试OAID,验证展示使用
    target_item TargetItemDTO 可选 活动会场定坑商品,此字段仅可在入参物料类型为2时使用,可在会场内指定位置展示指定商品
    • └ item_id_list
    • String []
    • 可选
    • ["top:mda76h9fa7-7dbaliu4q"]
    • 页面内定坑商品ID,用于素材-坑位还原
    manufacturer String 必须 huawei 推送厂商,huawei-华为, oppo-oppo, rongyao-荣耀, vivo-vivo, xiaomi-小米
    huawei_sp HwMap 可选 华为设备推送自定义参数集
    • └ back_pic_id
    • String
    • 可选
    • 123
    • 背景图ID
    • └ title_color
    • Number
    • 可选
    • 1
    • 标题字体颜色(仅配置背景图时生效,默认蓝色):1-蓝色、2-红色、3-白色
    • └ advanced_style
    • Number
    • 可选
    • 1
    • 展示方式(默认息屏展示):1-通知栏 2-亮屏 3-立即展示
    • └ icon_id
    • String
    • 可选
    • 123
    • icon图片id
    • └ small_pic_url
    • String
    • 可选
    • pic.aliyun.com
    • 小图url
    • └ notify_id
    • String
    • 可选
    • 20231111
    • 使用同一通知id的消息,后一条会覆盖前一条
    • └ unfold
    • Number
    • 可选
    • 1
    • 是否折叠(默认不折叠):0-折叠 1-不折叠
    • └ light_back_pic_id
    • String
    • 可选
    • 123
    • 鸿蒙4背景图ID
    oppo_sp OpMap 可选 Oppo设备推送自定义参数集
    • └ show_time
    • Number
    • 可选
    • 2
    • Opush展示时长,单位为小时(支持6-48)
    • └ notify_style
    • Number
    • 可选
    • 1
    • 通知栏样式,1-标准 2-长文本 3-大图
    • └ mid_pic_url
    • String
    • 可选
    • gw.alicdn.com
    • 中图url
    • └ big_pic_url
    • String
    • 可选
    • gw.alicdn.com
    • 大图url
    • └ material_id
    • String
    • 可选
    • 123
    • 素材ID
    • └ fold_group
    • String
    • 可选
    • group1
    • 免折叠分组标识
    • └ msg_label
    • Number
    • 可选
    • 1
    • 消息标签 1-热 2-惠 3-红包 4-直播 5-活动 6-荐
    • └ unfold
    • Number
    • 可选
    • 1
    • 0-折叠 1-不折叠 默认为0
    • └ is_top
    • Number
    • 可选
    • 1
    • 0-不置顶 1-置顶
    rongyao_sp RyMap 可选 荣耀设备推送自定义参数集
    • └ title_color
    • Number
    • 可选
    • 1
    • 标题颜色 1-红色 2-蓝色 3-紫色 4-橙色 5-绿色
    • └ advanced_style
    • Number
    • 可选
    • 1
    • 展示特性 1-亮屏 2-通知栏 3-亮屏+通知栏
    • └ back_pic_url
    • String
    • 可选
    • gw.alicdn.com
    • 背景图url
    • └ top_start_time
    • String
    • 可选
    • 2024-07-01 03:59
    • 置顶开始时间 开始结束时间必须连续,且最长不能超过4小时
    • └ top_end_time
    • String
    • 可选
    • 2024-07-02 03:59
    • 置顶结束时间
    • └ big_pic_url
    • String
    • 可选
    • gw.alicdn.com
    • 大图url
    • └ big_pic_expire_time
    • String
    • 可选
    • 2024-07-01 23:59
    • 大图过期时间,yyyy-MM-dd HH:mm
    • └ big_pic_expire_action
    • Number
    • 可选
    • 1
    • 大图过期后操作 0-自动清除 1-转普通消息
    • └ lock_ring
    • Number
    • 可选
    • 1
    • 锁屏铃声震动 0-关闭 1-开启
    for_inner_test Boolean 可选 false 是否发送测试消息
    vivo_sp VivoMap 可选 Vivo设备推送自定义参数集
    • └ notify_id
    • String
    • 可选
    • 20240110
    • 使用同一通知id的消息,后一条会覆盖前一条
    • └ cpc_price
    • String
    • 可选
    • 0.2
    • cpc出价
    • └ remind
    • Number
    • 可选
    • 1
    • 是否使用强提醒,1-是,0-否
    • └ creative_id
    • String
    • 可选
    • 123
    • 广告模板id,开发者可前往vivo 营销平台创建通知广告模板
    • └ is_scene
    • Number
    • 可选
    • 1
    • 是否场景化,1-是,0-否
    • └ style_type
    • Number
    • 可选
    • 1
    • 消息样式(消息样式需要与广告模板类型一致,1-标题+内容,类型纯文本;2-标题+内容+小图,类型小图;3-标题+内容+大图+小图(可选),类型大图
    • └ small_image_id
    • Number
    • 可选
    • 34234
    • 小图图片ID,需由代理同学先上传至VIVO营销平台
    • └ large_image_id
    • Number
    • 可选
    • 5454
    • 大图图片ID,需由代理同学先上传至VIVO营销平台
    xiaomi_sp XiaomiMap 可选 小米设备推送自定义参数集
    • └ big_pic_url
    • String
    • 可选
    • gw.alicdn.com
    • 大图url
    user_feature UserFeatureDTO 可选 用户特征信息列表,支持字段包括page_type:single/multi、brand:xxx、price:l1/l2/l3/l4/l5、category:xxx
    • └ feature_key
    • String
    • 可选
    • price
    • 特征键
    • └ feature_value
    • String
    • 可选
    • l1
    • 特征值

    响应参数

    名称 类型 示例值 描述
    status Number 1 状态:0-创建失败 1-待推送
    uvid String jo3iha09fn7ed 用户标识uvid
    input_item_id String mda76h9fa7-7dbaliu4q 入参商品ID
    create_time String 2024-01-24 16:04:38 创建时间
    msg_id String h7a9dht4l 推送唯一标识
    output_item_id String mda76h9fa7-7dbaliu4q 出参商品ID
    receipt String 请求成功 回执
    target_url String http://xxx.com 目标页面跳转地址

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    TbkMarketingMsgSendRequest req = new TbkMarketingMsgSendRequest();
    req.setFuncType(1L);
    req.setMsgId("h7a9dht4l");
    req.setMaterialType(1L);
    req.setTemplateId(7989L);
    req.setMaterialId("mda76h9fa7-7dbaliu4q");
    req.setUvid("jo3iha09fn7ed");
    req.setAdzoneId("123");
    req.setStartTime("2023-11-11 00:00:00");
    req.setTestOaid("OAID");
    TbkMarketingMsgSendRequest.TargetItemDTO obj1 = new TbkMarketingMsgSendRequest.TargetItemDTO();
    obj1.setItemIdList(""top:mda76h9fa7-7dbaliu4q"");
    req.setTargetItem(obj1);
    req.setManufacturer("huawei");
    TbkMarketingMsgSendRequest.HwMap obj2 = new TbkMarketingMsgSendRequest.HwMap();
    obj2.setBackPicId("123");
    obj2.setTitleColor(1L);
    obj2.setAdvancedStyle(1L);
    obj2.setIconId("123");
    obj2.setSmallPicUrl("pic.aliyun.com");
    obj2.setNotifyId("20231111");
    obj2.setUnfold(1L);
    obj2.setLightBackPicId("123");
    req.setHuaweiSp(obj2);
    TbkMarketingMsgSendRequest.OpMap obj3 = new TbkMarketingMsgSendRequest.OpMap();
    obj3.setShowTime(2L);
    obj3.setNotifyStyle(1L);
    obj3.setMidPicUrl("gw.alicdn.com");
    obj3.setBigPicUrl("gw.alicdn.com");
    obj3.setMaterialId("123");
    obj3.setFoldGroup("group1");
    obj3.setMsgLabel(1L);
    obj3.setUnfold(1L);
    obj3.setIsTop(1L);
    req.setOppoSp(obj3);
    TbkMarketingMsgSendRequest.RyMap obj4 = new TbkMarketingMsgSendRequest.RyMap();
    obj4.setTitleColor(1L);
    obj4.setAdvancedStyle(1L);
    obj4.setBackPicUrl("gw.alicdn.com");
    obj4.setTopStartTime("2024-07-01 03:59");
    obj4.setTopEndTime("2024-07-02 03:59");
    obj4.setBigPicUrl("gw.alicdn.com");
    obj4.setBigPicExpireTime("2024-07-01 23:59");
    obj4.setBigPicExpireAction(1L);
    obj4.setLockRing(1L);
    req.setRongyaoSp(obj4);
    req.setForInnerTest(false);
    TbkMarketingMsgSendRequest.VivoMap obj5 = new TbkMarketingMsgSendRequest.VivoMap();
    obj5.setNotifyId("20240110");
    obj5.setCpcPrice("0.2");
    obj5.setRemind(1L);
    obj5.setCreativeId("123");
    obj5.setIsScene(1L);
    obj5.setStyleType(1L);
    obj5.setSmallImageId(34234L);
    obj5.setLargeImageId(5454L);
    req.setVivoSp(obj5);
    TbkMarketingMsgSendRequest.XiaomiMap obj6 = new TbkMarketingMsgSendRequest.XiaomiMap();
    obj6.setBigPicUrl("gw.alicdn.com");
    req.setXiaomiSp(obj6);
    TbkMarketingMsgSendRequest.UserFeatureDTO obj7 = new TbkMarketingMsgSendRequest.UserFeatureDTO();
    obj7.setFeatureKey("price");
    obj7.setFeatureValue("l1");
    req.setUserFeature(obj7);
    TbkMarketingMsgSendResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <tbk_marketing_msg_send_response>
        <status>1</status>
        <uvid>jo3iha09fn7ed</uvid>
        <input_item_id>mda76h9fa7-7dbaliu4q</input_item_id>
        <create_time>2024-01-24 16:04:38</create_time>
        <msg_id>h7a9dht4l</msg_id>
        <output_item_id>mda76h9fa7-7dbaliu4q</output_item_id>
        <receipt>请求成功</receipt>
        <target_url>http://xxx.com</target_url>
    </tbk_marketing_msg_send_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

    返回
    顶部