这是我参与8月更文挑战的第30天,活动详情查看:8月更文挑战
获取二维码
我们推荐生成并使用小程序码,它具有更好的辨识度。目前有两个接口可以生成小程序码,开发者可以根据自己的需要选择合适的接口。
接口A: 适用于需要的码数量较少的业务场景
接口地址:api.weixin.qq.com/wxa/getwxac…
POST 参数说明
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| path | String | 不能为空,最大长度 128 字节 | |
| width | Int | 430 | 二维码的宽度 |
| auto_color | Bool | false | 自动配置线条颜色,如果颜色依然是黑色,则说明不建议配置主色调 |
| line_color | Object | {"r":"0","g":"0","b":"0"} | auth_color 为 false 时生效,使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} |
注意:通过该接口生成的小程序码,永久有效,数量限制见文末说明,请谨慎使用。用户扫描该码进入小程序后,将直接进入 path 对应的页面。
接口B:适用于需要的码数量极多,或仅临时使用的业务场景
接口地址:api.weixin.qq.com/wxa/getwxac…
POST 参数说明
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| scene | String | 最大32个可见字符,只支持数字,大小写英文以及部分特殊字符:!#$&'()*+,/:;=?@-._~,其它字符请自行编码为合法字符(因不支持%,中文无法使用 urlencode 处理,请使用其他编码方式) | |
| page | String | 必须是已经发布的小程序页面,例如 "pages/index/index" ,如果不填写这个字段,默认跳主页面 | |
| width | Int | 430 | 二维码的宽度 |
| auto_color | Bool | false | 自动配置线条颜色,如果颜色依然是黑色,则说明不建议配置主色调 |
| line_color | Object | {"r":"0","g":"0","b":"0"} | auto_color 为 false 时生效,使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} |
注意:通过该接口生成的小程序码,永久有效,数量暂无限制。用户扫描该码进入小程序后,开发者需在对应页面获取的码中 scene 字段的值,再做处理逻辑。使用如下代码可以获取到二维码中的 scene 字段的值。调试阶段可以使用开发工具的条件编译自定义参数 scene=xxxx 进行模拟,开发工具模拟时的 scene 的参数值需要进行 urlencode
获取小程序二维码
接口C:适用于需要的码数量较少的业务场景
接口地址:api.weixin.qq.com/cgi-bin/wxa…
POST 参数说明
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| path | String | 不能为空,最大长度 128 字节 | |
| width | Int | 430 | 二维码的宽度 |
注意:通过该接口生成的小程序二维码,永久有效,数量限制见文末说明,请谨慎使用。用户扫描该码进入小程序后,将直接进入 path 对应的页面。
示例:
{"path": "pages/index?query=1", "width": 430}
Bug & Tip
tip:通过该接口,仅能生成已发布的小程序的二维码。tip:可以在开发者工具预览时生成开发版的带参二维码。tip:接口A加上接口C,总共生成的码数量限制为100,000,请谨慎调用。tip: POST 参数需要转成 json 字符串,不支持 form 表单提交。tip: auto_color line_color 参数仅对小程序码生效。
错误码
45009:B接口调用分钟频率受限(目前5000次/分钟,会调整),如需大量小程序码,建议预生成。
45029:A接口和C接口生成码个数总和到达最大个数限制。
41030:B接口所传page页面不存在,或者小程序没有发布,请注意B接口没有path参数,传path参数虽然可以生成小程序码,但是只能跳主页面。