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

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

一、簡介

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

二、接口文檔

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

接口說明：

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

調(diào)用頻率

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

請求方式

POST

請求URL

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

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

{
      name: "測試直播房間1",  // 房間名字
      coverImg: "",   // 通過 uploadfile 上傳，填寫 mediaID
      startTime: 1588237130,   // 開始時間
      endTime: 1588237130 , // 結(jié)束時間
      anchorName: "zefzhang1",  // 主播昵稱
      anchorWechat: "WxgQiao_04",  // 主播微信號
      shareImg: "" ,  //通過 uploadfile 上傳，填寫 mediaID
      type: 1 , // 直播類型，1 推流 0 手機直播
      screenType: 0,  // 1：橫屏 0：豎屏
      closeLike: 0 , // 是否 關(guān)閉點贊 1 關(guān)閉
      closeGoods: 0, // 是否 關(guān)閉商品貨架，1：關(guān)閉
      closeComment: 0 // 是否開啟評論，1：關(guān)閉
}

請求參數(shù)含義

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

正確返回示例

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

返回參數(shù)含義

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

2.獲取直播間列表

接口說明

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

調(diào)用頻率

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

請求方式

POST

請求URL

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

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

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

請求參數(shù)含義

正確返回示例

{
    "errcode": 0,    // 錯誤碼，0代表成功，1代表未創(chuàng)建直播間
    "errmsg": "ok"   // 錯誤信息
    "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ù)

3.獲取直播間回放

接口說明

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

調(diào)用頻率

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

請求方法

POST

請求URL

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

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

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

請求參數(shù)含義

正確返回示例

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

返回參數(shù)含義

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

接口說明

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

調(diào)用頻率

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

請求方法

POST

請求URL

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

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

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

請求參數(shù)含義

正確返回示例

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

附錄：錯誤碼

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

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

1003：商品id不存在

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

200002：入?yún)㈠e誤

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

300002：名稱長度不符合規(guī)則

300006：圖片上傳失?。ㄈ纾簃ediaID過期）

300022：此房間號不存在

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

300024：商品不存在

300025：商品審核未通過

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

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

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

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

300030：主播微信號不合法

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

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

300033：添加商品超過直播間上限

300034：主播微信昵稱長度不符合要求

300035：主播微信號不存在

300036: 主播微信號未實名認(rèn)證

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

300038：未在小程序管理后臺配置客服

300039：主播副號微信號不合法

300040：名稱含有非限定字符（含有特殊字符）

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

9410000: 直播間列表為空

9410001: 獲取房間失敗

9410002: 獲取商品失敗

9410003: 獲取回放失敗