createQRCode

获取小程序/小游戏的二维码。该二维码可通过任意 app 扫码打开,能跳转到开发者指定的对应字节系 app 内拉起小程序/小游戏, 并传入开发者指定的参数。通过该接口生成的二维码,永久有效,暂无数量限制。

请求地址

POST https://developer.toutiao.com/api/apps/qrcode

请求参数

以下参数均在 JSON body 中。

属性数据类型必填默认值说明
access_tokenstring服务端 API 调用标识,获取方法
appnamestringtoutiao是打开二维码的字节系 app 名称,默认为今日头条,取值如下表所示
pathstring小程序/小游戏启动参数,小程序则格式为 encode({path}?{query}),小游戏则格式为 JSON 字符串,默认为空
widthint64430二维码宽度,单位 px,最小 280px,最大 1280px,默认为 430px
line_colorrgb{"r":0,"g":0,"b":0}二维码线条颜色,默认为黑色
backgroundrgb二维码背景颜色,默认为白色
set_iconboolFALSE是否展示小程序/小游戏 icon,默认不展示

appname的取值:

appname对应字节系 app
toutiao今日头条
douyin抖音
pipixia皮皮虾
huoshan火山小视频

返回值

当服务器端正确返回时,直接返回图片 Buffer。

数据类型描述
Array< byte >图片二进制

errCode

当服务器端无法正确返回时,返回值为 JSON 形式,会返回如下信息:

名称数据类型描述
errcodenumber错误号
errmsgstring错误信息

具体对应关系为:

错误号描述
0请求成功
-1系统错误
40002access_token 错误
40016appname 错误
40021width 超过指定范围
60003频率限制(目前 5000 次/分钟)
其它其它参数错误

请求示例

{
  "appname": "toutiao",
  "access_token": "XXX",
  "path": "",
  "width": 430,
  "line_color": { "r": 0, "g": 0, "b": 0 },
  "background": { "r": 255, "g": 255, "b": 255 },
  "set_icon": true
}

返回示例

错误返回

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

Bug & Tip

  • Tip: 小程序的 path 要 encode 一次,如 pages%3fparam%3dtrue,小游戏的 path 为 JSON 字符串,如{"param":true},否则会导致取不到。
  • Tip: 在使用该功能之前请记得先配置您的默认分享文案和图片,配置方式可参考论坛
点击纠错
评价此篇文档