获取小程序码
获取授权小程序的二维码。该二维码可通过任意 app 扫码打开,能跳转到开发者指定的对应字节系 app 内拉起小程序, 并传入开发者指定的参数。通过该接口生成的二维码,永久有效,暂无数量限制。
请求地址
POST https://developer.toutiao.com/api/apps/qrcode
Body 参数(json)
参数名 | 参数类型 | 是否必须 | 默认值 | 备注 |
---|---|---|---|---|
access_token | string | 是 | 授权小程序的接口调用令牌 | |
appname | string | 否 | toutiao | 打开二维码的字节系 app 名称,默认为今日头条,取值如下表所示 |
path | string | 否 | 小程序启动参数,格式为 encode({path}?{query}),默认为空 | |
width | int | 否 | 430 | 二维码宽度,单位 px,最小 280px,最大 1280px,默认为 430px |
line_color | object | 否 | {"r":0,"g":0,"b":0} | 二维码线条颜色,默认为黑色 |
background | object | 否 | {"r":255,"g":255,"b":255} | 二维码背景颜色,默认为白色 |
set_icon | bool | 否 | false | 是否展示小程序/小游戏 icon,默认不展示 |
appname 的取值
appname | 对应字节系 app |
---|---|
toutiao | 今日头条 |
douyin | 抖音 |
pipixia | 皮皮虾 |
huoshan | 火山小视频 |
Body 参数示例
{
"access_token": "XXX",
"appname": "toutiao",
"path": "",
"width": 430,
"line_color": { "r": 0, "g": 0, "b": 0 },
"background": { "r": 255, "g": 255, "b": 255 },
"set_icon": true
}
返回值
正确情况下返回图像的字节流,响应 header 中包含
HTTP/1.1 200 OK
Content-Type: image/png
返回值示例
{
"errcode": 40002,
"errmsg": "bad access_token"
}
错误码
错误码 | message |
---|---|
-1 | 系统错误 |
40002 | access_token 错误 |
40016 | appname 错误 |
40021 | width 超过指定范围 |
60003 | 频率限制(目前 5000 次/分钟) |
Bug & Tip
- Tip:小程序的 path 要 encode 一次,如 pages%3fparam%3dtrue,否则会导致取不到。
- Tip:在使用该功能之前请记得先配置您的默认分享文案和图片。
点击纠错
评价此篇文档