获取小程序码
收藏接口说明
获取小程序/小游戏的二维码或者抖音码（圆形的样式，异形码）。
二维码可通过任意 App 扫码打开，能跳转到开发者指定的对应字节系 App 内拉起小程序/小游戏， 并传入开发者指定的参数，抖音码仅支持字节系 App 扫码打开。
通过该接口生成的二维码永久生效。
开发者调用该接口来生成小程序二维码/抖音码，返回二维码图片二进制的base64编码。
使用限制
无
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/api/apps/v1/qrcode/create/ |
| HTTP Method | POST |
| Scope | apps.qrcode.create |
| 权限要求 |
|
请求参数
请求头
access-token必填String
示例：clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例：application/json
固定值"application/json"
Body展开全部子属性
appid必填String
示例：tt********
小程序id
app_nameString
示例：toutiao
打开二维码的字节系 app 名称，默认为今日头条，取值如下所示：
- toutiao：今日头条
- toutiao_lite：今日头条极速版
- douyin：抖音
- douyin_lite：抖音极速版
- pipixia：皮皮虾
- huoshan：火山小视频
- xigua：西瓜视频
- all：全宿主，即在哪个宿主扫码就在哪个宿主打开小程序，若某个宿主没有该小程序，兜底往抖音app跳转
backgroundStruct
二维码背景颜色，默认为白色
展开子属性
is_circle_codeBool
传true表示生成圆形的抖音码，类似：
传false表示生成普通的正方形二维码。
line_colorStruct
二维码线条颜色，默认为黑色
展开子属性
pathString
示例：小程序参考示例：pages%2Fmiddle%2Findex%3Fscene%3D771b216132e24d8e90af7467b744f0a6
小程序/小游戏启动参数，小程序则格式为 encode({path}?{query})，小游戏则格式为 JSON 字符串，默认为空
set_iconBool
示例：FALSE
是否展示小程序/小游戏 icon，默认不展示。
该字段仅当is_circle_code设置为false，即获取方形码的时候有效。
widthInt32
示例：430
二维码宽度，单位 px
请求示例
curl --location --request POST 'https://open.douyin.com/api/apps/v1/qrcode/create/' \ --header 'Content-Type: application/json' \ --header 'access-token: clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1******' --data-raw '{ "app_name": "douyin", "appid": "tt**********", "path": "{}", "width": 1000, "line_color": { "r": 0, "g": 0, "b": 0 }, "background": { "r": 0, "g": 0, "b": 0 }, "set_icon": false }'
响应参数
Body展开全部子属性
data必填Struct
展开子属性
err_msg必填String
错误信息
err_no必填Int32
错误码
log_id必填String
字节内部log_id，用于问题快速定位
响应示例
正常响应示例异常响应示例
{ "err_no": 0, "err_msg": "", "log_id": "202403081551526176B7485DDDA9025BXX", "data": { "img": "#######" } }
切换单列布局错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 28005001 | 参数解析失败 | 检查参数必填字段和类型 |
| 200 | 28005006 | 小程序名称异常 | 小程序名称异常 |
| 200 | 28001008 | access_token错误 | 重新获取access_token，见client_token获取说明 |
| 200 | 28005005 | 长宽超出限制 | 重新设置合理长宽 |
| 200 | 28005002 | 系统异常 | 重试 |
| 200 | 28005004 | 频率超出限制 | 稍后重试 |
