createQRCode

2020-02-15 01:34 更新

獲取小程序/小游戲的二維碼。該二維碼可通過任意 app 掃碼打開,能跳轉到開發(fā)者指定的對應字節(jié)系 app 內(nèi)拉起小程序/小游戲, 并傳入開發(fā)者指定的參數(shù)。通過該接口生成的二維碼,永久有效,暫無數(shù)量限制。


接口地址

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


輸入

以下參數(shù)均在 JSON body 中。

名稱必填默認值描述
access_token服務端 API 調(diào)用標識,獲取方法
appnametoutiao是打開二維碼的字節(jié)系 app 名稱,默認為今日頭條,取值如下表所示
path小程序/小游戲啟動參數(shù),小程序則格式為 encode({path}?{query}),小游戲則格式為 JSON 字符串,默認為空
width430二維碼寬度,單位 px,最小 280px,最大 1280px,默認為 430px
line_color{"r":0,"g":0,"b":0}二維碼線條顏色,默認為黑色
background二維碼背景顏色,默認為透明
set_iconFALSE是否展示小程序/小游戲 icon,默認不展示

appname的取值:

appname對應字節(jié)系 app
toutiao今日頭條
douyin抖音
pipixia皮皮蝦
huoshan火山小視頻
?? 注意
在使用該功能之前請記得先配置您的默認分享文案和圖片,配置方式可參考論壇。


輸出

當服務器端正確返回時,返回圖片 Buffer。

當服務器端無法正確返回時,返回值為 JSON 形式,會返回如下信息:

名稱數(shù)據(jù)類型描述
errcodenumber錯誤號
errmsgstring錯誤信息

具體對應關系為:

錯誤號描述
0請求成功
-1系統(tǒng)錯誤
40002access_token 錯誤
40016appname 錯誤
40021width 超過指定范圍
60003頻率限制(目前 5000 次/分鐘)
其它其它參數(shù)錯誤


示例

body 示例如下:

{
    "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
}
?? 注意
小程序的 path 要 encode 一次,如 pages%3fparam%3dtrue,小游戲的 path 為 JSON 字符串,如{"param":true},否則會導致取不到。


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號