文档中心 > API类目 > 码上淘API

taobao.wireless.xcode.create (创建二维码/短连接)

创建码平台的普通二维码或者长连接转短连接服务

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
biz_code String 可选 top
  • 默认值:top
  • 码平台开放的业务code
    content String 必须 http://ma.t.aobao.com 原始内容/原始地址
    style QrCodeStyle 可选 普通二维码样式参数
    • └ bg_color
    • Number
    • 可选
    • 16711680
    • 可选参数,二维背景色颜色值,接入业务点配置为准,未配置,默认为白
    • └ logo
    • String
    • 可选
    • demo
    • 可选参数,logo的淘宝tfs地址,默认无
    • └ level
    • Number
    • 可选
    • 0
    • 可选参数,二维码纠错级别 0=~7%,1=~15%,2=~25%,3=~30%
    • └ color
    • Number
    • 可选
    • 16711680
    • 可选参数,二维码深色点颜色值,接入业务点配置为准,未配置,默认为黑
    • └ margin
    • Number
    • 可选
    • 1
    • 可选参数,二维码的边框,默认大小1个单位点,便于扫码
    • └ size
    • Number
    • 可选
    • 185
    • 可选参数,二维码大小,值60~600,默认185pix

    响应参数

    名称 类型 示例值 描述
    xcode XCodeTo 创建二维码/短连接 返回信息
    • └ img_url
    • String
    • http://img.alicdn.com/tfscom/TB1TjUeHVXXXXb.XXXXwu0bFXXX.png
    • 二维码图片地址
    • └ id
    • Number
    • 123
    • 记录ID
    • └ gmt_modified
    • Date
    • 2015-07-30 11:45:25
    • 最后修改时间
    • └ gmt_create
    • Date
    • 2015-07-30 11:45:25
    • 创建时间
    • └ status
    • Number
    • 1
    • 码的状态,1-生效,0-未生效,-1-逻辑删除。
    • └ user_id
    • Number
    • 123
    • 所属用户ID,如果入参没有用户登录信息,则随机生成
    • └ life_start
    • Date
    • 2015-07-30 11:45:25
    • 有效期开始时间
    • └ short_url
    • String
    • http://m.tb.cn/x.Dxdf
    • 短连接
    • └ short_name
    • String
    • x.Dxdf
    • 短连接关键字符
    • └ life_end
    • Date
    • 2015-07-30 11:45:25
    • 有效期结束时间,使用短链接跳转的,结束后不再可以访问

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    WirelessXcodeCreateRequest req = new WirelessXcodeCreateRequest();
    req.setBizCode("top");
    req.setContent("http://ma.t.aobao.com");
    QrCodeStyle obj1 = new QrCodeStyle();
    obj1.setBgColor(16711680L);
    obj1.setLogo("demo");
    obj1.setLevel(0L);
    obj1.setColor(16711680L);
    obj1.setMargin(1L);
    obj1.setSize(185L);
    req.setStyle(obj1);
    WirelessXcodeCreateResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <wireless_xcode_create_response>
        <xcode>
            <img_url>http://img.alicdn.com/tfscom/TB1TjUeHVXXXXb.XXXXwu0bFXXX.png</img_url>
            <id>123</id>
            <gmt_modified>2015-07-30 11:45:25</gmt_modified>
            <gmt_create>2015-07-30 11:45:25</gmt_create>
            <status>1</status>
            <user_id>123</user_id>
            <life_start>2015-07-30 11:45:25</life_start>
            <short_url>http://m.tb.cn/x.Dxdf</short_url>
            <short_name>x.Dxdf</short_name>
            <life_end>2015-07-30 11:45:25</life_end>
        </xcode>
    </wireless_xcode_create_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

    返回
    顶部