开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
文档中心
开发文档(v3版) 
支付
私域
小程序产品
权限集列表
搜索关键词
搜索直达
收藏
消息
小程序码
api 列表
小程序二维码
小程序服务
订单中心
小程序开发管理
生物核身
交易组件
小程序商品
支付有礼
小游戏
公域
营销
资金
会员
信用
安全
广告
小程序云
其他
api文档 > 私域 > 小程序产品 > 权限集列表 > 小程序码 >  >  > 小程序生成推广二维码接口
收藏
订阅更新
我的文档
设置

接口说明

接口英文名称:alipay.open.app.qrcode.create
请求url:https://openapi.alipay.com/v3/alipay/open/app/qrcode/create
请求方式:post
path指该参数为路径参数
query指该参数需在请求url传参
body指该参数需在请求json传参
生成小程序推广二维码

公共请求参数

参数类型是否必选最大长度描述示例值
authorizationstring必选1024
请求身份信息,参考验签规则。在header参数中传递
content-typestring可选32
报文内容格式,默认需要使用application/json,加密请求使用text/plain,参考请求规则。在header参数中传递
application/json
x-http-method-overridestring可选16
http方法,对于部分不支持put、patch、delete等操作的情况,可以使用post发送请求,并通过该参数传输实际需要使用的http method,参考请求规则。在header参数中传递
put
alipay-request-idstring可选32
调用方的requestid,用于定位一次请求,需要每次请求保持唯一。排查问题时可以提供该字段,参考请求规则。在header参数中传递。
0ba7cddb1665744697169391253118
alipay-encrypt-typestring可选16
加密算法,请求使用加密能力时,需要指定加密算法,参考加解密规则。在header参数中传递
aes
alipay-root-cert-snstring可选128
支付宝根证书序列号。证书模式时,可传入该参数,支付宝服务端会校验序列号,确保调用方的证书未被篡改,参考验签规则。在header参数中传递
687b59193f3f462dd5336e5abf83c5d8_02941eef3187dddf3d3b83462e1dfcf6
alipay-app-auth-tokenstring可选128
应用授权令牌,参考代调用规则。在header参数中传递
201509bbeff9351ad1874306903e96b91d248a36

业务请求参数

body参数
url_param|跳转小程序的页面路径必选string[1,256]
【描述】page/component/component-pages/view/view为小程序中能访问到的页面路径
【示例值】page/component/component-pages/view/view
query_param|小程序的启动参数必选string[1,256]
【描述】小程序启动参数,内容按照格式为参数名=参数值&参数名=参数值。打开小程序的query ,在小程序 onlaunch的方法中获取。可查看 如何获取各种场景的启动参数
【示例值】key1=value1&key2=value2
describe|码描述必选string[1,32]
【描述】对应的二维码描述
【示例值】二维码描述
color|码颜色可选string[1,16]
【描述】圆形二维码颜色(十六进制颜色色值),仅圆形二维码支持颜色设置,方形二维码默认为黑色。
【示例值】0x00bfff
size|合成后图片的大小可选string[1,16]
【描述】合成后图片的大小规格,有s、m、l三档可选。
【枚举值】
8cm大小: s
12cm大小: m
30cm大小: l
【示例值】s
常见请求示例
curl -x post \
 "https://openapi.alipay.com/v3/alipay/open/app/qrcode/create" \
 -h "authorization: alipay-sha256withrsa app_id=${appid},timestamp=${now},nonce=${uuid},expired_seconds=600,sign=${sign}" \
 -h "alipay-request-id: ${requestid}" \
 -h "alipay-app-auth-token: ${app_auth_token}" \
 -h "content-type: application/json" \
 -d '{
	"url_param":"page/component/component-pages/view/view",
	"query_param":"x=1",
	"describe":"二维码描述"
}'
说明:本示例仅供参考。

公共响应参数

参数中文名参数英文名类型是否必选最大长度描述示例值
支付宝响应时间戳alipay-timestampstring可选32
unix时间戳,用于验签及问题排查,参考验签规则。在header参数中传递
1666004496123
支付宝响应签名alipay-signaturestring可选512
支付宝响应报文签名,参考验签规则。在header中返回
支付宝traceidalipay-traceidstring可选64
支付宝traceid ,用于排查问题使用,参考请求规则。在header中返回
0ba7cddb1665744697169391253118
支付宝随机串alipay-noncestring可选64
支付宝nonce标记,每次请求会生成不同的nonce,可用于防重放判断,参考请求规则。在header中返回
515cf24c2f78b13564e94c2a495695ab

业务响应参数

qr_code_url|方形二维码图片链接地址必选string(1024)
【描述】方形二维码图片链接地址
【示例值】http://mmtcdp.stable.alipay.net/wsdk/img?fileid=a*lsbpt5i9c1waaaaaaaaaaabjaqaaaa&t=9005d7f574f30246b89c20c17302115f&bz=mmtcafts&
qr_code_url_circle_white|白底圆码链接地址可选string(256)
【描述】圆形二维码地址,白色slogan
【示例值】https://mdgwdev.alipay.net/wsdk/img?fileid=a*frfsrq-nxbkaaaaaaaaaaaaaaqaaaq&bz=am_afts_openhome&zoom=800w_800h
qr_code_url_circle_blue|蓝底圆码链接地址可选string(256)
【描述】圆形二维码地址,蓝色slogan
【示例值】https://mdgwdev.alipay.net/wsdk/img?fileid=a*kufuqrwzfdsaaaaaaaaaaaaaaqaaaq&bz=am_afts_openhome&zoom=800w_800h
响应示例
{
	"qr_code_url":"http://mmtcdp.stable.alipay.net/wsdk/img?fileid=a*lsbpt5i9c1waaaaaaaaaaabjaqaaaa&t=9005d7f574f30246b89c20c17302115f&bz=mmtcafts&",
	"qr_code_url_circle_white":"https://mdgwdev.alipay.net/wsdk/img?fileid=a*frfsrq-nxbkaaaaaaaaaaaaaaqaaaq&bz=am_afts_openhome&zoom=800w_800h",
	"qr_code_url_circle_blue":"https://mdgwdev.alipay.net/wsdk/img?fileid=a*kufuqrwzfdsaaaaaaaaaaaaaaqaaaq&bz=am_afts_openhome&zoom=800w_800h"
}
说明:本示例仅供参考。

公共错误码

前往查看

业务错误码

状态码错误码错误描述凯发app官方网站的解决方案
400system_error系统繁忙
服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试
400invalid_parameter参数有误
请根据接口返回的参数非法的具体错误信息,修改参数后进行重试
400hm_bg_color_invalid小程序码背景颜色非法
小程序码背景颜色非法,请检查输入颜色代码是否合法
400qrcode_desc_check_invalid小程序码描述含违规信息
小程序码描述含违规信息,请修改小程序码描述
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
网站地图