获取小程序码
接口说明
获取小程序/小游戏的二维码或者抖音码(圆形的样式,异形码)。
二维码可通过任意 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"
Body展开全部子属性
app_nameString
appidString
backgroundStruct
展开子属性
is_circle_codeBool
line_colorStruct
展开子属性
pathString
set_iconBool
widthInt32
请求示例
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展开全部子属性
dataStruct
展开子属性
err_msgString
err_noInt32
log_idString
响应示例
正常响应示例异常响应示例
{ "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 | 频率超出限制 | 稍后重试 |
