alipay.open.public.qrcode.create(带参推广二维码接口) 在线调试(沙箱环境)

为了满足用户渠道推广分析的需要,公众平台提供了生成带参数二维码的接口。使用该接口可以获得多个带不同场景值的二维码,用户扫描后,公众号可以接收到事件推送。目前有2种类型的二维码,分别是临时二维码、和永久二维码,前者有过期时间,最大为1800秒。 每次创建二维码ticket需要提供一个开发者自行设定的参数(scene_id)。

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.open.public.qrcode.create
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
code_info CodeInfo 可选 服务窗创建带参二维码接口,开发者自定义信息
scene Scene 可选 5000 场景信息
scene_id String 可选 32 场景Id,最长32位,英文字母、数字以及下划线,开发者自定义 1234
goto_url String 可选 1024 跳转URL,扫码关注服务窗后会直接跳转到此URL http://www.******.com
code_type String 可选 32 二维码类型,目前只支持两种类型:
TEMP:临时的(默认);
PERM:永久的
TEMP
expire_second String 可选 8 临时码过期时间,以秒为单位,最大不超过1800秒;
永久码置空
1000
show_logo String 可选 4 二维码中间是否显示服务窗logo,Y:显示;N:不显示(默认) N

响应参数

参数 类型 是否必填 最大长度 描述 示例值
code_img String 必填 1024 二维码图片地址,可跳转到实际图片 https://mobilecodec.alipay.com/show.htm?code=pvj4hi212zvdbk05bb&picSize=M
expire_second String 必填 8 二维码有效时间,单位(秒)。永久码暂时忽略该信息 1800

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOpenPublicQrcodeCreateRequest request = new AlipayOpenPublicQrcodeCreateRequest();
request.setBizContent("{" +
"\"code_info\":{" +
"\"scene\":{" +
"\"scene_id\":\"1234\"" +
"      }," +
"\"goto_url\":\"http://www.******.com\"" +
"    }," +
"\"code_type\":\"TEMP\"," +
"\"expire_second\":\"1000\"," +
"\"show_logo\":\"N\"" +
"  }");
AlipayOpenPublicQrcodeCreateResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_open_public_qrcode_create_response": {
        "code": "10000",
        "msg": "Success",
        "code_img": "https://mobilecodec.alipay.com/show.htm?code=pvj4hi212zvdbk05bb&picSize=M",
        "expire_second": "1800"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "alipay_open_public_qrcode_create_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
PARSE_XML_JSON_ERROR 解析XML/JSON出错 请检查输入参数的格式
ILLEGAL_BIZ_PARAMS 无效的业务参数 请检查输入的参数是否正确
SYSTEM_ERROR 系统繁忙 请检查输入参数是否正确,或者稍后重试
onlineServer