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

文档中心 > API类目 > 千牛接口

taobao.bcpush.genpassword.get (淘口令生成接口)

供新春红包功能生成淘口令来分享链接

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
app_name String 可选 top
  • 默认值:top
  • top
    email String 可选 kaidong.rkd@alibaba-inc.com
  • 默认值:kaidong.rkd@alibaba-inc.com
  • 邮箱
    param GenPasswordParamDto 可选 参数
    • └ template_id
    • String
    • 可选
    • template_id
    • 淘口令回流展示的模板ID
    • └ source_type
    • String
    • 可选
    • source_type
    • item|shop|other
    • └ password_type
    • String
    • 可选
    • tao
    • 默认传"tao"
    • └ title
    • String
    • 必须
    • title
    • title
    • └ pic_url
    • String
    • 可选
    • pic_url
    • pic_url
    • └ target
    • String
    • 可选
    • target
    • target
    • └ pop_url
    • String
    • 可选
    • pop_url
    • pop_url
    • └ pop_type
    • String
    • 可选
    • pop_type
    • pop_type
    • └ open_app_name
    • String
    • 可选
    • open_app_name
    • open_app_name
    • └ biz_id
    • String
    • 可选
    • biz_id
    • biz_id
    • └ extend_info
    • String
    • 可选
    • extend_info
    • extend_info
    • └ target_url
    • String
    • 必须
    • target_url
    • target_url

    响应参数

    名称 类型 示例值 描述
    result ShareResult result result
    • └ model
    • String
    • model
    • model
    • └ total_number
    • Number
    • totalNumber
    • totalNumber
    • result_code
    • ResultCode
    • resultCode
    • resultCode
    • └ message
    • String
    • message
    • message
    • └ code
    • String
    • code
    • code
    • └ is_success
    • Boolean
    • isSuccess
    • isSuccess

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    BcpushGenpasswordGetRequest req = new BcpushGenpasswordGetRequest();
    req.setAppName("top");
    req.setEmail("kaidong.rkd@alibaba-inc.com");
    BcpushGenpasswordGetRequest.GenPasswordParamDto obj1 = new BcpushGenpasswordGetRequest.GenPasswordParamDto();
    obj1.setTemplateId("template_id");
    obj1.setSourceType("source_type");
    obj1.setPasswordType("tao");
    obj1.setTitle("title");
    obj1.setPicUrl("pic_url");
    obj1.setTarget("target");
    obj1.setPopUrl("pop_url");
    obj1.setPopType("pop_type");
    obj1.setOpenAppName("open_app_name");
    obj1.setBizId("biz_id");
    obj1.setExtendInfo("extend_info");
    obj1.setTargetUrl("target_url");
    req.setParam(obj1);
    BcpushGenpasswordGetResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <bcpush_genpassword_get_response>
        <result>
            <model>model</model>
            <total_number>totalNumber</total_number>
            <result_code>
                <message>message</message>
                <code>code</code>
            </result_code>
            <is_success>isSuccess</is_success>
        </result>
    </bcpush_genpassword_get_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

    返回
    顶部