createQRCode
收藏接口说明
获取小程序/小游戏的二维码。该二维码可通过任意 app 扫码打开，能跳转到开发者指定的对应字节系 app 内拉起小程序/小游戏，并传入开发者指定的参数。通过该接口生成的二维码，永久有效，暂无数量限制。
⚠️ Tip：
在使用该功能之前请记得先配置您的默认分享文案和图片，配置方式可参考论坛。
⚠️ Tip：小程序的 path 要 encode 一次，如 pages%3fparam%3dtrue，小游戏的 path 为 JSON 字符串，如{"param":true}，否则会导致取不到。
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://minigame.zijieapi.com/mgplatform/api/apps/qrcode |
| HTTP Method | POST |
| Scope | open.ttgame.mgplatform |
请求参数
请求头
content-type必填String
示例：application/json
固定值"application/json"
Body展开全部子属性
access_token必填String
示例：08011218462b6b4b5054626e426e50685a7554643144644449413d3d
appname必填String
是打开二维码的字节系 app 名称，默认为今日头条
- toutiao 今日头条
- douyin 抖音
- pipixia 皮皮虾
- huoshan 火山小游戏
path必填String
小程序/小游戏启动参数，小程序则格式为 encode({path}?{query})，小游戏则格式为 JSON 字符串，默认为空
width必填Int32
二维码宽度，单位 px，最小 280px，最大 1280px，默认为 430px
backgroundStruct
二维码背景颜色，默认为透明
展开子属性
line_colorStruct
二维码线条颜色，默认为黑色
展开子属性
set_iconBool
是否展示小程序/小游戏 icon，默认不展示
请求示例
curl -X POST \ -H "content-type: application/json" \ -d '{"access_token":"080112184636*****512b4472644453673d3d","appname":"douyin","path":"/","width":0,"line_color":{"r":0,"g":0,"b":0},"background":{"r":255,"g":255,"b":255},"set_icon":false}' \ https://minigame.zijieapi.com/mgplatform/api/apps/qrcode
响应参数
Body
dataBinary
二维码图片
errcodeInt64
错误号
errmsgString
错误信息
响应示例
正常响应示例异常响应示例
直接返回图片的 []byte 数组
错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 0 | 成功 | |
| 200 | -1 | 系统错误 | |
| 200 | 40002 | access_token 错误 | |
| 200 | 40016 | appname 错误 | |
| 200 | 40021 | width 超过指定范围 | |
| 200 | 60003 | 频率限制（目前 5000 次 / 分钟） |
