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

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

商业化消息推送

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
func_type Number 必须 1
  • 默认值:0
  • 功能类型,0-测试 1-推送 2-查询 3-中止
    msg_id String 可选 h7a9dht4l 单次消息推送唯一标识
    material_type Number 可选 1
  • 默认值:1
  • 物料类型,1-单品,2-活动会场,默认为1
    template_id Number 可选 7989 小二提供或素材库下载的模板ID
    material_id String 可选 mda76h9fa7-7dbaliu4q 推送物料ID,与物料类型一一对应,如类型为单品时,请传入新商品ID
    uvid String 可选 jo3iha09fn7ed 用户标识
    adzone_id String 必须 123 pid三段式的第三段
    small_pic_url String 可选 pic.aliyun.com 特性:小图url
    icon_id String 可选 123 特性:iconId
    back_pic_id String 可选 123 特性:背景图id
    notify_id String 可选 20231111 通知id,使用同一通知id的消息,后一条会覆盖前一条
    title_color Number 可选 1 标题颜色,1-蓝色
    advanced_style Number 可选 1 展示特性,1-下拉通知栏通知 2-亮屏通知 3-立即展示
    unfold Number 可选 0
  • 默认值:0
  • 消息不折叠,0-折叠 1-不折叠 默认为0
    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,用于素材-坑位还原

    响应参数

    名称 类型 示例值 描述
    status Number 1 状态:0-创建失败 1-待推送 2-推送中 3-已推送 4-已终止 5-已过期
    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 请求成功 回执

    请求示例

    • 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.setSmallPicUrl("pic.aliyun.com");
    req.setIconId("123");
    req.setBackPicId("123");
    req.setNotifyId("20231111");
    req.setTitleColor(1L);
    req.setAdvancedStyle(1L);
    req.setUnfold(0L);
    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);
    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>
    </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

    返回
    顶部