抖音开放平台Logo
控制台

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-typeString是application/json
固定值"application/json"

请求参数

Body

名称字段类型是否必填示例描述
access_tokenString是08011218462b6b4b5054626e426e50685a7554643144644449413d3d
调用https://minigame.zijieapi.com/mgplatform/api/apps/v2/token生成的token
appnameString是

是打开二维码的字节系 app 名称，默认为今日头条

  • toutiao 今日头条
  • douyin 抖音
  • pipixia 皮皮虾
  • huoshan 火山小游戏
pathString是
小程序/小游戏启动参数，小程序则格式为 encode({path}?{query})，小游戏则格式为 JSON 字符串，默认为空
widthInt32是
二维码宽度，单位 px，最小 280px，最大 1280px，默认为 430px
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 数组

异常响应示例

{
  "errcode": 40002,
  "errmsg": "bad access_token"
}

错误码

http状态码错误码错误码描述排查建议
2000
成功
200-1
系统错误
20040002
access_token 错误
20040016
appname 错误
20040021
width 超过指定范围
20060003
频率限制（目前 5000 次 / 分钟）