閱讀(8.5k) 書(shū)簽贊(0) 我要糾錯(cuò)

微信小程序服務(wù)端接口·直播間接口

2020-10-21 11:54 更新

【小程序直播】直播間管理接口

名稱(chēng)	功能說(shuō)明
創(chuàng)建直播間	該接口可直接創(chuàng)建直播間，創(chuàng)建成功后直播間將在直播間列表展示
獲取直播房間列表	該接口可獲取直播房間列表
獲取直播間回放	該接口可在直播結(jié)束后拿到回放源視頻
直播間導(dǎo)入商品	調(diào)用此接口往指定直播間導(dǎo)入已入庫(kù)的商品

一、簡(jiǎn)介

直播間管理接口，是小程序直播提供給開(kāi)發(fā)者對(duì)直播房間進(jìn)行批量操作的接口能力。開(kāi)發(fā)者可以創(chuàng)建直播間、獲取直播間信息、獲取直播間回放以及往直播間導(dǎo)入商品。

二、接口文檔

1.創(chuàng)建直播間

接口說(shuō)明：

調(diào)用此接口創(chuàng)建直播間，創(chuàng)建成功后將在直播間列表展示

調(diào)用頻率

調(diào)用額度：10000次/一天

請(qǐng)求方式

POST

請(qǐng)求URL

https://api.weixin.qq.com/wxaapi/broadcast/room/create?access_token=

請(qǐng)求參數(shù)示例： json

{
      name: "測(cè)試直播房間1",  // 房間名字
      coverImg: "",   // 通過(guò) uploadfile 上傳，填寫(xiě) mediaID
      startTime: 1588237130,   // 開(kāi)始時(shí)間
      endTime: 1588237130 , // 結(jié)束時(shí)間
      anchorName: "zefzhang1",  // 主播昵稱(chēng)
      anchorWechat: "WxgQiao_04",  // 主播微信號(hào)
      shareImg: "" ,  //通過(guò) uploadfile 上傳，填寫(xiě) mediaID
      type: 1 , // 直播類(lèi)型，1 推流 0 手機(jī)直播
      screenType: 0,  // 1：橫屏 0：豎屏
      closeLike: 0 , // 是否 關(guān)閉點(diǎn)贊 1 關(guān)閉
      closeGoods: 0, // 是否 關(guān)閉商品貨架，1：關(guān)閉
      closeComment: 0 // 是否開(kāi)啟評(píng)論，1：關(guān)閉
}

請(qǐng)求參數(shù)含義

參數(shù) 類(lèi)型必填說(shuō)明
name String 是直播間名字，最短3個(gè)漢字，最長(zhǎng)17個(gè)漢字，1個(gè)漢字相當(dāng)于2個(gè)字符
coverImg String 是背景圖，填入mediaID（mediaID獲取后，三天內(nèi)有效）；圖片mediaID的獲取，請(qǐng)參考以下文檔： https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html；直播間背景圖，圖片規(guī)則：建議像素10801920，大小不超過(guò)2M
startTime Number 是直播計(jì)劃開(kāi)始時(shí)間（開(kāi)播時(shí)間需要在當(dāng)前時(shí)間的10分鐘后并且開(kāi)始時(shí)間不能在 6 個(gè)月后）
endTime Number 是直播計(jì)劃結(jié)束時(shí)間（開(kāi)播時(shí)間和結(jié)束時(shí)間間隔不得短于30分鐘，不得超過(guò)24小時(shí)）
anchorName String 是主播昵稱(chēng)，最短2個(gè)漢字，最長(zhǎng)15個(gè)漢字，1個(gè)漢字相當(dāng)于2個(gè)字符
anchorWechat String 是主播微信號(hào)，如果未實(shí)名認(rèn)證，需要先前往“小程序直播”小程序進(jìn)行實(shí)名驗(yàn)證, 小程序二維碼鏈接：https://res.wx.qq.com/op_res/BbVNeczA1XudfjVqCVoKgfuWe7e3aUhokktRVOqf_F0IqS6kYR--atCpVNUUC3zr
subAnchorWechat String 否主播副號(hào)微信號(hào)，如果未實(shí)名認(rèn)證，需要先前往“小程序直播”小程序進(jìn)行實(shí)名驗(yàn)證, 小程序二維碼鏈接：https://res.wx.qq.com/op_res/BbVNeczA1XudfjVqCVoKgfuWe7e3aUhokktRVOqf_F0IqS6kYR--atCpVNUUC3zr
createrWechat String 否創(chuàng)建者微信號(hào)
shareImg String 是分享圖，填入mediaID（mediaID獲取后，三天內(nèi)有效）；圖片mediaID的獲取，請(qǐng)參考以下文檔： https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html；直播間分享圖，圖片規(guī)則：建議像素800640，大小不超過(guò)1M；
feedsImg String 否購(gòu)物直播頻道封面圖，填入mediaID（mediaID獲取后，三天內(nèi)有效）；圖片mediaID的獲取，請(qǐng)參考以下文檔： https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html; 購(gòu)物直播頻道封面圖，圖片規(guī)則：建議像素800*800，大小不超過(guò)100KB；
isFeedsPublic Number 否是否開(kāi)啟官方收錄【1: 開(kāi)啟，0：關(guān)閉】，默認(rèn)開(kāi)啟收錄
type Number 是直播間類(lèi)型【1: 推流，0：手機(jī)直播】
screenType Number 是橫屏、豎屏【1：橫屏，0：豎屏】（橫屏：視頻寬高比為16:9、4:3、1.85:1 ；豎屏：視頻寬高比為9:16、2:3）
closeLike Number 是是否關(guān)閉點(diǎn)贊【0：開(kāi)啟，1：關(guān)閉】（若關(guān)閉，直播開(kāi)始后不允許開(kāi)啟）
closeGoods Number 是是否關(guān)閉貨架【0：開(kāi)啟，1：關(guān)閉】（若關(guān)閉，直播開(kāi)始后不允許開(kāi)啟）
closeComment Number 是是否關(guān)閉評(píng)論【0：開(kāi)啟，1：關(guān)閉】（若關(guān)閉，直播開(kāi)始后不允許開(kāi)啟）
closeReplay Number 否是否關(guān)閉回放【0：開(kāi)啟，1：關(guān)閉】默認(rèn)關(guān)閉回放
closeShare Number 否是否關(guān)閉分享【0：開(kāi)啟，1：關(guān)閉】默認(rèn)開(kāi)啟分享（直播開(kāi)始后不允許修改）
closeKf Number 否是否關(guān)閉客服【0：開(kāi)啟，1：關(guān)閉】默認(rèn)關(guān)閉客服

參數(shù)	類(lèi)型	必填	說(shuō)明
name	String	是	直播間名字，最短3個(gè)漢字，最長(zhǎng)17個(gè)漢字，1個(gè)漢字相當(dāng)于2個(gè)字符
coverImg	String	是	背景圖，填入mediaID（mediaID獲取后，三天內(nèi)有效）；圖片mediaID的獲取，請(qǐng)參考以下文檔： https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html；直播間背景圖，圖片規(guī)則：建議像素1080*1920，大小不超過(guò)2M
startTime	Number	是	直播計(jì)劃開(kāi)始時(shí)間（開(kāi)播時(shí)間需要在當(dāng)前時(shí)間的10分鐘后并且開(kāi)始時(shí)間不能在 6 個(gè)月后）
endTime	Number	是	直播計(jì)劃結(jié)束時(shí)間（開(kāi)播時(shí)間和結(jié)束時(shí)間間隔不得短于30分鐘，不得超過(guò)24小時(shí)）
anchorName	String	是	主播昵稱(chēng)，最短2個(gè)漢字，最長(zhǎng)15個(gè)漢字，1個(gè)漢字相當(dāng)于2個(gè)字符
anchorWechat	String	是	主播微信號(hào)，如果未實(shí)名認(rèn)證，需要先前往“小程序直播”小程序進(jìn)行實(shí)名驗(yàn)證, 小程序二維碼鏈接：https://res.wx.qq.com/op_res/BbVNeczA1XudfjVqCVoKgfuWe7e3aUhokktRVOqf_F0IqS6kYR--atCpVNUUC3zr
subAnchorWechat	String	否	主播副號(hào)微信號(hào)，如果未實(shí)名認(rèn)證，需要先前往“小程序直播”小程序進(jìn)行實(shí)名驗(yàn)證, 小程序二維碼鏈接：https://res.wx.qq.com/op_res/BbVNeczA1XudfjVqCVoKgfuWe7e3aUhokktRVOqf_F0IqS6kYR--atCpVNUUC3zr
createrWechat	String	否	創(chuàng)建者微信號(hào)
shareImg	String	是	分享圖，填入mediaID（mediaID獲取后，三天內(nèi)有效）；圖片mediaID的獲取，請(qǐng)參考以下文檔： https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html；直播間分享圖，圖片規(guī)則：建議像素800*640，大小不超過(guò)1M；
feedsImg	String	否	購(gòu)物直播頻道封面圖，填入mediaID（mediaID獲取后，三天內(nèi)有效）；圖片mediaID的獲取，請(qǐng)參考以下文檔： https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html; 購(gòu)物直播頻道封面圖，圖片規(guī)則：建議像素800*800，大小不超過(guò)100KB；
isFeedsPublic	Number	否	是否開(kāi)啟官方收錄【1: 開(kāi)啟，0：關(guān)閉】，默認(rèn)開(kāi)啟收錄
type	Number	是	直播間類(lèi)型【1: 推流，0：手機(jī)直播】
screenType	Number	是	橫屏、豎屏【1：橫屏，0：豎屏】（橫屏：視頻寬高比為16:9、4:3、1.85:1 ；豎屏：視頻寬高比為9:16、2:3）
closeLike	Number	是	是否關(guān)閉點(diǎn)贊【0：開(kāi)啟，1：關(guān)閉】（若關(guān)閉，直播開(kāi)始后不允許開(kāi)啟）
closeGoods	Number	是	是否關(guān)閉貨架【0：開(kāi)啟，1：關(guān)閉】（若關(guān)閉，直播開(kāi)始后不允許開(kāi)啟）
closeComment	Number	是	是否關(guān)閉評(píng)論【0：開(kāi)啟，1：關(guān)閉】（若關(guān)閉，直播開(kāi)始后不允許開(kāi)啟）
closeReplay	Number	否	是否關(guān)閉回放【0：開(kāi)啟，1：關(guān)閉】默認(rèn)關(guān)閉回放
closeShare	Number	否	是否關(guān)閉分享【0：開(kāi)啟，1：關(guān)閉】默認(rèn)開(kāi)啟分享（直播開(kāi)始后不允許修改）
closeKf	Number	否	是否關(guān)閉客服【0：開(kāi)啟，1：關(guān)閉】默認(rèn)關(guān)閉客服

正確返回示例

{
    "roomId": 33, //房間ID
    "errcode": 0
}

返回參數(shù)含義

參數(shù) 說(shuō)明
roomId 房間ID
qrcode_url "小程序直播" 小程序碼

參數(shù)	說(shuō)明
roomId	房間ID
qrcode_url	"小程序直播" 小程序碼

2.獲取直播間列表

接口說(shuō)明

調(diào)用此接口獲取直播間列表及直播間信息

調(diào)用頻率

調(diào)用額度：100000次/一天（與獲取回放接口共用次數(shù)）

請(qǐng)求方式

POST

請(qǐng)求URL

https://api.weixin.qq.com/wxa/business/getliveinfo?access_token=

請(qǐng)求參數(shù)示例： json

{
    "start": 0, // 起始拉取房間，start = 0 表示從第 1 個(gè)房間開(kāi)始拉取
    "limit": 10 // 每次拉取的個(gè)數(shù)上限，不要設(shè)置過(guò)大，建議 100 以?xún)?nèi)
}

請(qǐng)求參數(shù)含義

參數(shù)	類(lèi)型	必填	說(shuō)明
start	Number	是	起始房間，0表示從第1個(gè)房間開(kāi)始拉取
limit	Number	是	每次拉取的房間數(shù)量，建議100以?xún)?nèi)

正確返回示例

{
    "errcode": 0,    // 錯(cuò)誤碼，0代表成功，1代表未創(chuàng)建直播間
    "errmsg": "ok"   // 錯(cuò)誤信息
    "room_info":[{
        "name":"直播房間名"
        "roomid": 1,
        "cover_img":"http://http:\/\/mmbiz.qpic.cn\/mmbiz_jpg\Rl1RuuhdstSfZa8EEljedAYcbtX3Ejpdl2et1tPAQ37bdicnxoVialDLCKKDcPBy8Iic0kCiaiaalXg3EbpNKoicrweQ\/0?wx_fmt=jpeg",
        "share_img":"http://http:\/\/mmbiz.qpic.cn\/mmbiz_jpg\Rl1RuuhdstSfZa8EEljedAYcbtX3Ejpdl2et1tPAQ37bdicnxoVialDLCKKDcPBy8Iic0kCiaiaalXg3EbpNKoicrweQ\/0?wx_fmt=jpeg",
        "live_status": 101,
        "start_time": 1568128900,
        "end_time": 1568131200,
        "anchor_name":"里斯",
        "goods":[{
             "cover_img":"http://http:\/\/mmbiz.qpic.cn\/mmbiz_jpg\/Rl1RuuhdstSfZa8EEljedAYcbtX3Ejpdl2et1tPAQ37bdicnxoVialDLCKKDcPBy8Iic0kCiaiaalXg3EbpNKoicrweQ\/0?wx_fmt=jpeg",
             "url":"pages/index/index.html",
             "price":1100,
             "name":"茶杯"}],
        "total":1
    }]
}

返回參數(shù)含義

房間參數(shù)

參數(shù)	說(shuō)明
name	直播間名稱(chēng)
roomid	直播間ID
cover_img	直播間背景圖鏈接
share_img	直播間分享圖鏈接
live_status	直播間狀態(tài)。101：直播中，102：未開(kāi)始，103已結(jié)束，104禁播，105：暫停，106：異常，107：已過(guò)期
start_time	直播間開(kāi)始時(shí)間，列表按照start_time降序排列
end_time	直播計(jì)劃結(jié)束時(shí)間
anchor_name	主播名
total	拉取房間總數(shù)

商品參數(shù)

參數(shù)	說(shuō)明
cover_img	商品封面圖鏈接
url	商品小程序路徑
price	商品價(jià)格
name	商品名稱(chēng)

3.獲取直播間回放

接口說(shuō)明

調(diào)用接口獲取已結(jié)束直播間的回放源視頻（一般在直播結(jié)束后10分鐘內(nèi)生成，源視頻無(wú)評(píng)論等內(nèi)容）

調(diào)用頻率

調(diào)用額度：100000次/一天

請(qǐng)求方法

POST

請(qǐng)求URL

https://api.weixin.qq.com/wxa/business/getliveinfo?access_token=

請(qǐng)求參數(shù)示例： json

{
     "action": "get_replay",  
     "room_id": 354,   
     "start": 0,   
     "limit": 10        
}

請(qǐng)求參數(shù)含義

參數(shù)	類(lèi)型	必填	說(shuō)明
action	String	是	獲取回放
room_id	Number	是	直播間ID
start	Number	是	起始拉取視頻，0表示從第一個(gè)視頻片段開(kāi)始拉取
limit	Number	是	每次拉取的數(shù)量，建議100以?xún)?nèi)

正確返回示例

{
     "live_replay":[{
         "expire_time":"",
         "create_time":"",
         "media_url":""
      }],
      "errcode": 0,
      "total": 1,
      "errmsg":"ok"
}

返回參數(shù)含義

參數(shù)	說(shuō)明
expire_time	回放視頻url過(guò)期時(shí)間
create_time	回放視頻創(chuàng)建時(shí)間
media_url	回放視頻鏈接
total	回放視頻片段個(gè)數(shù)

4.直播間導(dǎo)入商品

接口說(shuō)明

調(diào)用接口往指定直播間導(dǎo)入已入庫(kù)的商品

調(diào)用頻率

調(diào)用額度：10000次/一天

請(qǐng)求方法

POST

請(qǐng)求URL

https://api.weixin.qq.com/wxaapi/broadcast/room/addgoods?access_token=

請(qǐng)求參數(shù)示例： json

{
    "ids": [1150, 1111],  // 數(shù)組列表，可傳入多個(gè)，里面填寫(xiě) 商品 ID
    "roomId": 2554
}

請(qǐng)求參數(shù)含義

參數(shù)	類(lèi)型	必填	說(shuō)明
ids	Array<Number>	是	數(shù)組列表，可傳入多個(gè)，里面填寫(xiě) 商品 ID
roomId	Number	是	房間ID

正確返回示例

{
   "errcode": 0 // 0：成功
}

附錄：錯(cuò)誤碼

-1：系統(tǒng)錯(cuò)誤

1：未創(chuàng)建直播間

1003：商品id不存在

47001：入?yún)⒏袷讲环弦?guī)范

200002：入?yún)㈠e(cuò)誤

300001：禁止創(chuàng)建/更新商品或禁止編輯&更新房間

300002：名稱(chēng)長(zhǎng)度不符合規(guī)則

300006：圖片上傳失敗（如：mediaID過(guò)期）

300022：此房間號(hào)不存在

300023：房間狀態(tài) 攔截（當(dāng)前房間狀態(tài)不允許此操作）

300024：商品不存在

300025：商品審核未通過(guò)

300026：房間商品數(shù)量已經(jīng)滿額

300027：導(dǎo)入商品失敗

300028：房間名稱(chēng)違規(guī)

300029：主播昵稱(chēng)違規(guī)

300030：主播微信號(hào)不合法

300031：直播間封面圖不合規(guī)

300032：直播間分享圖違規(guī)

300033：添加商品超過(guò)直播間上限

300034：主播微信昵稱(chēng)長(zhǎng)度不符合要求

300035：主播微信號(hào)不存在

300036: 主播微信號(hào)未實(shí)名認(rèn)證

300037：購(gòu)物直播頻道封面圖不合規(guī)

300038：未在小程序管理后臺(tái)配置客服

300039：主播副號(hào)微信號(hào)不合法

300040：名稱(chēng)含有非限定字符（含有特殊字符）

300041：創(chuàng)建者微信號(hào)不合法

9410000: 直播間列表為空

9410001: 獲取房間失敗

9410002: 獲取商品失敗

9410003: 獲取回放失敗

以上內(nèi)容是否對(duì)您有幫助：

← 微信小程序小程序直播·接入說(shuō)明

微信小程序服務(wù)端接口·商品管理接口 →

寫(xiě)筆記

我要補(bǔ)充

您使用了广告拦截器。请将 www.w3cschool.cn 加入白名单，解除广告屏蔽后，刷新页面。谢谢。

微信小程序 服務(wù)端接口·直播間接口

【小程序直播】直播間管理接口

一、簡(jiǎn)介

二、接口文檔

1.創(chuàng)建直播間

接口說(shuō)明：

調(diào)用頻率

請(qǐng)求方式

請(qǐng)求URL

請(qǐng)求參數(shù)示例： json

請(qǐng)求參數(shù)含義

正確返回示例

返回參數(shù)含義

參數(shù)說(shuō)明roomId房間IDqrcode_url"小程序直播" 小程序碼

2.獲取直播間列表

接口說(shuō)明

調(diào)用頻率

請(qǐng)求方式

請(qǐng)求URL

請(qǐng)求參數(shù)示例： json

請(qǐng)求參數(shù)含義

正確返回示例

返回參數(shù)含義

3.獲取直播間回放

接口說(shuō)明

調(diào)用頻率

請(qǐng)求方法

請(qǐng)求URL

請(qǐng)求參數(shù)示例： json

請(qǐng)求參數(shù)含義

正確返回示例

返回參數(shù)含義

4.直播間導(dǎo)入商品

接口說(shuō)明

調(diào)用頻率

請(qǐng)求方法

請(qǐng)求URL

請(qǐng)求參數(shù)示例： json

請(qǐng)求參數(shù)含義

正確返回示例

附錄：錯(cuò)誤碼

推薦文章

推薦教程

推薦課程

微信小程序服務(wù)端接口·直播間接口

一、簡(jiǎn)介

二、接口文檔

參數(shù) 說(shuō)明
roomId 房間ID
qrcode_url "小程序直播" 小程序碼