# 【小程序直播】直播間管理接口
| 名稱 | 功能說明 |
|---|---|
| 創(chuàng)建直播間 | 該接口可直接創(chuàng)建直播間,創(chuàng)建成功后直播間將在直播間列表展示 |
| 獲取直播房間列表 | 該接口可獲取直播房間列表 |
| 獲取直播間回放 | 該接口可在直播結束后拿到回放源視頻 |
| 直播間導入商品 | 調(diào)用此接口往指定直播間導入已入庫的商品 |
| 刪除直播間 | 刪除直播間 |
| 編輯直播間 | 編輯直播間 |
| 獲取直播間推流地址 | 獲取直播間推流地址 |
| 獲取直播間分享二維碼 | 獲取直播間分享二維碼 |
| 添加管理直播間小助手 | 添加管理直播間小助手 |
| 修改管理直播間小助手 | 修改管理直播間小助手 |
| 刪除管理直播間小助手 | 刪除管理直播間小助手 |
| 查詢管理直播間小助手 | 查詢管理直播間小助手 |
| 添加主播副號 | 添加主播副號 |
| 修改主播副號 | 修改主播副號 |
| 刪除主播副號 | 刪除主播副號 |
| 獲取主播副號 | 獲取主播副號 |
| 開啟/關閉直播間官方收錄 | 開啟/關閉直播間官方收錄 |
| 開啟/關閉回放功能 | 開啟/關閉回放功能 |
| 開啟/關閉客服功能 | 開啟/關閉客服功能 |
| 開啟/關閉直播間全局禁言 | 開啟/關閉直播間全局禁言 |
| 上下架商品 | 上下架商品 |
| 刪除商品 | 刪除商品 |
| 推送商品 | 推送商品 |
| 商品排序 | 商品排序 |
| 下載商品講解視頻 | 下載商品講解視頻 |
# 一、簡介
直播間管理接口,是小程序直播提供給開發(fā)者對直播房間進行批量操作的接口能力。 開發(fā)者可以創(chuàng)建直播間、獲取直播間信息、獲取直播間回放以及往直播間導入商品。
# 二、接口文檔
# 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 , // 結束時間
anchorName: "zefzhang1", // 主播昵稱
anchorWechat: "WxgQiao_04", // 主播微信號
subAnchorWechat: "WxgQiao_03", // 主播副號微信號
createrWechat: 'test_creater', // 創(chuàng)建者微信號
shareImg: "hw7zsntcr0rE-RBfBAaF553DqBk-J02UtWsP8VqrUh3tKu3jO_JwEO8n1cWTJ5TN" , //通過 uploadfile 上傳,填寫 mediaID
feedsImg: "hw7zsntcr0rE-RBfBAaF553DqBk-J02UtWsP8VqrUh3tKu3jO_JwEO8n1cWTJ5TN", //通過 uploadfile 上傳,填寫 mediaID
isFeedsPublic: 1, // 是否開啟官方收錄,1 開啟,0 關閉
type: 1 , // 直播類型,1 推流 0 手機直播
closeLike: 0 , // 是否關閉點贊 1:關閉
closeGoods: 0, // 是否關閉商品貨架,1:關閉
closeComment: 0 // 是否開啟評論,1:關閉
closeReplay: 1 , // 是否關閉回放 1 關閉
closeShare: 0, // 是否關閉分享 1 關閉
closeKf: 0, // 是否關閉客服,1 關閉
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| name | String | 是 | 直播間名字,最短3個漢字,最長17個漢字,1個漢字相當于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 | 是 | 直播計劃開始時間(開播時間需要在當前時間的10分鐘后 并且 開始時間不能在 6 個月后) |
| endTime | Number | 是 | 直播計劃結束時間(開播時間和結束時間間隔不得短于30分鐘,不得超過24小時) |
| anchorName | String | 是 | 主播昵稱,最短2個漢字,最長15個漢字,1個漢字相當于2個字符 |
| anchorWechat | String | 是 | 主播微信號,如果未實名認證,需要先前往“小程序直播”小程序進行實名驗證, 小程序二維碼鏈接:https://res.wx.qq.com/op_res/9rSix1dhHfK4rR049JL0PHJ7TpOvkuZ3mE0z7Ou_Etvjf-w1J_jVX0rZqeStLfwh |
| subAnchorWechat | String | 否 | 主播副號微信號,如果未實名認證,需要先前往“小程序直播”小程序進行實名驗證, 小程序二維碼鏈接:https://res.wx.qq.com/op_res/9rSix1dhHfK4rR049JL0PHJ7TpOvkuZ3mE0z7Ou_Etvjf-w1J_jVX0rZqeStLfwh |
| createrWechat | String | 否 | 創(chuàng)建者微信號,不傳入則此直播間所有成員可見。傳入則此房間僅創(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:關閉】,默認開啟收錄 |
| type | Number | 是 | 直播間類型 【1: 推流,0:手機直播】 |
| closeLike | Number | 是 | 是否關閉點贊 【0:開啟,1:關閉】(若關閉,觀眾端將隱藏點贊按鈕,直播開始后不允許開啟) |
| closeGoods | Number | 是 | 是否關閉貨架 【0:開啟,1:關閉】(若關閉,觀眾端將隱藏商品貨架,直播開始后不允許開啟) |
| closeComment | Number | 是 | 是否關閉評論 【0:開啟,1:關閉】(若關閉,觀眾端將隱藏評論入口,直播開始后不允許開啟) |
| closeReplay | Number | 否 | 是否關閉回放 【0:開啟,1:關閉】默認關閉回放(直播開始后允許開啟) |
| closeShare | Number | 否 | 是否關閉分享 【0:開啟,1:關閉】默認開啟分享(直播開始后不允許修改) |
| closeKf | Number | 否 | 是否關閉客服 【0:開啟,1:關閉】 默認關閉客服(直播開始后允許開啟) |
# 正確返回示例
{
"roomId": 33, //房間ID
"errcode": 0,
// 當主播微信號沒有在 “小程序直播“ 小程序?qū)嵜J證 返回該字段
"qrcode_url": "https://res.wx.qq.com/op_res/9rSix1dhHfK4rR049JL0PHJ7TpOvkuZ3mE0z7Ou_Etvjf-w1J_jVX0rZqeStLfwh"
}
# 返回參數(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ù)上限,不要設置過大,建議 100 以內(nèi)
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| start | Number | 是 | 起始房間,0表示從第1個房間開始拉取 |
| limit | Number | 是 | 每次拉取的房間數(shù)量,建議100以內(nèi) |
# 正確返回示例
{
"errcode": 0, // 錯誤碼,0代表成功,1代表未創(chuàng)建直播間
"errmsg": "ok", // 錯誤信息
"total":1,
"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",
"name":"茶杯",
"price": 1889, // 價格(分)
"price2": 0,
"price_type": 1, // 價格類型,1:一口價(只需要傳入price,price2不傳) 2:價格區(qū)間(price字段為左邊界,price2字段為右邊界,price和price2必傳) 3:顯示折扣價(price字段為原價,price2字段為現(xiàn)價, price和price2必傳)
"goods_id": 256, // 商品id
"third_party_appid": "wx3d0fae56402d8a81" //第三方商品appid ,當前小程序商品則為空
}],
"live_type": 0, // 直播類型,1 推流 0 手機直播
"close_like": 0, // 是否關閉點贊 【0:開啟,1:關閉】(若關閉,觀眾端將隱藏點贊按鈕,直播開始后不允許開啟)
"close_goods": 0, // 是否關閉貨架 【0:開啟,1:關閉】(若關閉,觀眾端將隱藏商品貨架,直播開始后不允許開啟)
"close_comment": 0, // 是否關閉評論 【0:開啟,1:關閉】(若關閉,觀眾端將隱藏評論入口,直播開始后不允許開啟)
"close_kf": 1, // 是否關閉客服 【0:開啟,1:關閉】 默認關閉客服(直播開始后允許開啟)
"close_replay": 1, // 是否關閉回放 【0:開啟,1:關閉】默認關閉回放(直播開始后允許開啟)
"is_feeds_public": 0, // 是否開啟官方收錄,1 開啟,0 關閉
"creater_openid": "oawjt4t9NWZV2BYaEPA89sh1XblE", // 創(chuàng)建者openid
"feeds_img": "XXX" // 官方收錄封面
}]
}
# 返回參數(shù)含義
房間參數(shù)
| 參數(shù) | 說明 |
|---|---|
| name | 直播間名稱 |
| roomid | 直播間ID |
| cover_img | 直播間背景圖鏈接 |
| share_img | 直播間分享圖鏈接 |
| live_status | 直播間狀態(tài)。101:直播中,102:未開始,103已結束,104禁播,105:暫停,106:異常,107:已過期 |
| start_time | 直播間開始時間,列表按照start_time降序排列 |
| end_time | 直播計劃結束時間 |
| anchor_name | 主播名 |
| live_type | 直播類型,1 推流 0 手機直播 |
| close_like | 是否關閉點贊 【0:開啟,1:關閉】(若關閉,觀眾端將隱藏點贊按鈕,直播開始后不允許開啟) |
| close_goods | 是否關閉貨架 【0:開啟,1:關閉】(若關閉,觀眾端將隱藏商品貨架,直播開始后不允許開啟) |
| close_comment | 是否關閉評論 【0:開啟,1:關閉】(若關閉,觀眾端將隱藏評論入口,直播開始后不允許開啟) |
| close_kf | 是否關閉客服 【0:開啟,1:關閉】 默認關閉客服(直播開始后允許開啟) |
| close_replay | 是否關閉回放 【0:開啟,1:關閉】默認關閉回放(直播開始后允許開啟) |
| is_feeds_public | 是否開啟官方收錄,1 開啟,0 關閉 |
| creater_openid | 創(chuàng)建者openid |
| feeds_img | 官方收錄封面 |
| total | 拉取房間總數(shù) |
商品參數(shù)
| 參數(shù) | 說明 |
|---|---|
| cover_img | 商品封面圖鏈接 |
| url | 商品小程序路徑 |
| price | 商品價格(分) |
| name | 商品名稱 |
| price2 | 商品價格,使用方式看price_type |
| price_type | 價格類型,1:一口價(只需要傳入price,price2不傳) 2:價格區(qū)間(price字段為左邊界,price2字段為右邊界,price和price2必傳) 3:顯示折扣價(price字段為原價,price2字段為現(xiàn)價, price和price2必傳) |
| goods_id | 商品id |
| third_party_appid | 第三方商品appid ,當前小程序商品則為空 |
# 3.獲取直播間回放
# 接口說明
調(diào)用接口獲取已結束直播間的回放源視頻(一般在直播結束后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ù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| action | String | 是 | 獲取回放 |
| room_id | Number | 是 | 直播間ID |
| start | Number | 是 | 起始拉取視頻,0表示從第一個視頻片段開始拉取 |
| limit | Number | 是 | 每次拉取的數(shù)量,建議100以內(nèi) |
# 正確返回示例
{
"live_replay":[{
"expire_time":"",
"create_time":"",
"media_url":""
}],
"errcode": 0,
"total": 1,
"errmsg":"ok"
}
# 返回參數(shù)含義
| 參數(shù) | 說明 |
|---|---|
| expire_time | 回放視頻url過期時間 |
| create_time | 回放視頻創(chuàng)建時間 |
| media_url | 回放視頻鏈接 |
| total | 回放視頻片段個數(shù) |
# 4.直播間導入商品
# 接口說明
調(dià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ù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| ids | Array<Number> | 是 | 數(shù)組列表,可傳入多個,里面填寫?商品?ID |
| roomId | Number | 是 | 房間ID |
# 正確返回示例
{
"errcode": 0 // 0:成功
}
# 5.刪除直播間
# 接口說明
刪除直播間
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/deleteroom?access_token=
# 請求參數(shù)示例: json
{
"id" : 6491
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| id | Number | 是 | 房間ID |
# 正確返回示例
{
"errcode": 0 // 0:成功
}
# 6.編輯直播間
# 接口說明
編輯直播間
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/editroom?access_token=
# 請求參數(shù)示例: json
{
"id": 811,
"name": "測試更新副號1",
"coverImg": "hw7zsntcr0rE-RBfBAaF553DqBk-J02UtWsP8VqrUh3tKu3jO_JwEO8n1cWTJ5TN",
"startTime": 1607443200,
"endTime": 1607450400,
"anchorName": "主播昵稱11",
"anchorWechat": "lintest1",
"shareImg": "hw7zsntcr0rE-RBfBAaF553DqBk-J02UtWsP8VqrUh3tKu3jO_JwEO8n1cWTJ5TN",
"closeLike": 0,
"closeGoods": 0,
"closeComment": 0,
"isFeedsPublic": 0,
"closeReplay": 0,
"closeShare": 0,
"closeKf": 0,
"feedsImg": "hw7zsntcr0rE-RBfBAaF553DqBk-J02UtWsP8VqrUh3tKu3jO_JwEO8n1cWTJ5TN"
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| id | Number | 是 | 直播間id |
| name | String | 是 | 直播間名字,最短3個漢字,最長17個漢字,1個漢字相當于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 | 是 | 直播計劃開始時間(開播時間需要在當前時間的10分鐘后 并且 開始時間不能在 6 個月后) |
| endTime | Number | 是 | 直播計劃結束時間(開播時間和結束時間間隔不得短于30分鐘,不得超過24小時) |
| anchorName | String | 是 | 主播昵稱,最短2個漢字,最長15個漢字,1個漢字相當于2個字符 |
| anchorWechat | String | 是 | 主播微信號,如果未實名認證,需要先前往“小程序直播”小程序進行實名驗證, 小程序二維碼鏈接:https://res.wx.qq.com/op_res/9rSix1dhHfK4rR049JL0PHJ7TpOvkuZ3mE0z7Ou_Etvjf-w1J_jVX0rZqeStLfwh |
| 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:關閉】,默認開啟收錄 |
| closeLike | Number | 是 | 是否關閉點贊 【0:開啟,1:關閉】(若關閉,觀眾端不展示點贊入口,直播開始后不允許開啟) |
| closeGoods | Number | 是 | 是否關閉貨架 【0:開啟,1:關閉】(若關閉,觀眾端不展示商品貨架,直播開始后不允許開啟) |
| closeComment | Number | 是 | 是否關閉評論 【0:開啟,1:關閉】(若關閉,觀眾端不展示評論入口,直播開始后不允許開啟) |
| closeReplay | Number | 否 | 是否關閉回放 【0:開啟,1:關閉】默認關閉回放(直播開始后允許開啟) |
| closeShare | Number | 否 | 是否關閉分享 【0:開啟,1:關閉】默認開啟分享(直播開始后不允許修改) |
| closeKf | Number | 否 | 是否關閉客服 【0:開啟,1:關閉】 默認關閉客服(直播開始后允許開啟) |
# 正確返回示例
{
"errcode": 0 // 0:成功
}
# 7.獲取直播間推流地址
# 接口說明
獲取直播間推流地址
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
GET
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/getpushurl?access_token=
# URL query 參數(shù)
{
"roomId" : 6209
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| roomId | Number | 是 | 房間ID |
# 正確返回示例
{
"pushAddr": "rtmp://wxalivepush.weixin.qq.com/live/wx40f8626ddf43d362-6209?txSecret=5da4f0b7b7a6c25b238311de8c81a65a&txTime=5fc4f631",
"errcode": 0
}
# 8.獲取直播間分享二維碼
# 接口說明
獲取直播間分享二維碼
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
GET
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/getsharedcode?access_token=
# URL query 參數(shù)
{
"roomId" : 6209,
"params" : encodeURIComponent(JSON.stringify(custom_params))
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| roomId | Number | 是 | 房間ID |
| params | String | 否 | 自定義參數(shù) |
# 正確返回示例
{
"cdnUrl": "http://mmbiz.qpic.cn/mmbiz_jpg/FVribAGdErI2jhO1hbzVDH1E5LW7VQ9D1SIvTLFmyYwkIUucJqE72icgAj6NYw92kbJRNV0zwnGZWaO0Y8T0vqlg/0", // 分享二維碼
"pagePath": "plugin-private://wx2b03c6e691cd7370/pages/live-player-plugin?room_id=6209", // 分享路徑
"posterUrl": "http://mmbiz.qpic.cn/mmbiz_jpg/dlFudV139LtQn96YNHSGtVfcUkUwQaYeR5OiaJ6bPr7OZxy3yhIK3icjxop0QeRBiaDPiaxuzENtCj15zFIM8sh7ag/0", // 分享海報
"errcode": 0
}
# 9.添加管理直播間小助手
# 接口說明
添加管理直播間小助手
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/addassistant?access_token=
# 請求參數(shù)示例: json
{
"roomId": 6474,
"users": [{"username":"testwechat","nickname":"testnick"}]
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| roomId | Number | 是 | 房間ID |
| users | Array<Object> | 是 | 用戶數(shù)組 |
| username | String | 是 | 用戶微信號 |
| nickname | String | 是 | 用戶昵稱 |
# 正確返回示例
{
"errcode": 0 // 0:成功
}
# 10.修改管理直播間小助手
# 接口說明
修改管理直播間小助手
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/modifyassistant?access_token=
# 請求參數(shù)示例: json
{
"roomId": 6474,
"username": "testwechat",
"nickname": "testnick"
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| roomId | Number | 是 | 房間ID |
| username | String | 是 | 用戶微信號 |
| nickname | String | 是 | 用戶微信昵稱 |
# 正確返回示例
{
"errcode": 0 // 0:成功
}
# 11.刪除管理直播間小助手
# 接口說明
刪除管理直播間小助手
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/removeassistant?access_token=
# 請求參數(shù)示例: json
{
"roomId": 6623,
"username": "testwechat"
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| roomId | Number | 是 | 房間ID |
| username | String | 是 | 用戶微信號 |
# 正確返回示例
{
"errcode": 0 // 0:成功
}
# 12.查詢管理直播間小助手
# 接口說明
查詢管理直播間小助手
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
GET
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/getassistantlist?access_token=
# URL query 參數(shù)
{
"roomId" : 6491
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| roomId | Number | 是 | 房間ID |
# 正確返回示例
{
"list": [
{
"timestamp": 1601199369,
"headimg": "http://wx.qlogo.cn/mmhead/USXYj7XUar4OmtmhpYR3IS1X54ibLgjcNjEXp3ne5C6I/0",
"nickname": "nickname",
"alias": "wechat",
"openid": "o7esq5K76p47O-ien1kuaVAuSsvw"
}
],
"count": 1,
"maxCount": 10,
"errcode": 0
}
# 返回參數(shù)含義
| 參數(shù) | 類型 | 說明 |
|---|---|---|
| list | Array<Object> | 小助手列表 |
| count | Number | 小助手個數(shù) |
| maxCount | Number | 小助手最大個數(shù) |
| timestamp | Number | 修改時間 |
| headimg | String | 頭像 |
| nickname | String | 昵稱 |
| alias | String | 微信號 |
| openid | String | openid |
# 13.添加主播副號
# 接口說明
添加主播副號
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/addsubanchor?access_token=
# 請求參數(shù)示例: json
{
"roomId": 6827,
"username": "lintest2"
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| roomId | Number | 是 | 房間ID |
| username | String | 是 | 用戶微信號 |
# 正確返回示例
{
"errcode": 0 // 0:成功
}
# 14.修改主播副號
# 接口說明
修改主播副號
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/modifysubanchor?access_token=
# 請求參數(shù)示例: json
{
"roomId": 6827,
"username": "wechattest"
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| roomId | Number | 是 | 房間ID |
| username | String | 是 | 微信號 |
# 正確返回示例
{
"errcode": 0 // 0:成功
}
# 15.刪除主播副號
# 接口說明
刪除主播副號
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/deletesubanchor?access_token=
# 請求參數(shù)示例: json
{
"roomId" : 6491
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| roomId | Number | 是 | 房間ID |
# 正確返回示例
{
"errcode": 0 // 0:成功
}
# 16.獲取主播副號
# 接口說明
獲取主播副號
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
GET
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/getsubanchor?access_token=
# URL query 參數(shù)
{
"roomId" : 6491
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| roomId | Number | 是 | 房間ID |
# 正確返回示例
{
"username": "testwechat",
"errcode": 0
}
# 17.開啟/關閉直播間官方收錄
# 接口說明
開啟/關閉直播間官方收錄
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/updatefeedpublic?access_token=
# 請求參數(shù)示例: json
{
"roomId": 6474,
"isFeedsPublic" : 0
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| roomId | Number | 是 | 房間ID |
| isFeedsPublic | Number | 是 | 是否開啟官方收錄 【1: 開啟,0:關閉】 |
# 正確返回示例
{
"errcode": 0 // 0:成功
}
# 18.開啟/關閉回放功能
# 接口說明
開啟/關閉回放功能
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/updatereplay?access_token=
# 請求參數(shù)示例: json
{
"roomId": 6474,
"closeReplay" : 0
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| roomId | Number | 是 | 房間ID |
| closeReplay | Number | 是 | 是否關閉回放 【0:開啟,1:關閉】 |
# 正確返回示例
{
"errcode": 0 // 0:成功
}
# 19.開啟/關閉客服功能
# 接口說明
開啟/關閉客服功能
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/updatekf?access_token=
# 請求參數(shù)示例: json
{
"roomId" : 6491,
"closeKf" : 0
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| roomId | Number | 是 | 房間ID |
| closeKf | Number | 是 | 是否關閉客服 【0:開啟,1:關閉】 |
# 正確返回示例
{
"errcode": 0 // 0:成功
}
# 20.開啟/關閉直播間全局禁言
# 接口說明
開啟/關閉直播間全局禁言
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/updatecomment?access_token=
# 請求參數(shù)示例: json
{
"roomId": 6474,
"banComment" : 1
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| id | Number | 是 | 房間ID |
| banComment | Number | 是 | 1-禁言,0-取消禁言 |
# 正確返回示例
{
"errcode": 0 // 0:成功
}
# 21.上下架商品
# 接口說明
上下架商品
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/goods/onsale?access_token=
# 請求參數(shù)示例: json
{
"roomId": 6474,
"goodsId" : 1,
"onSale": 0
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| roomId | Number | 是 | 房間ID |
| goodsId | Number | 是 | 商品ID |
| onSale | Number | 是 | 上下架 【0:下架,1:上架】 |
# 正確返回示例
{
"errcode": 0 // 0:成功
}
# 22.刪除商品
# 接口說明
刪除直播間商品
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/goods/deleteInRoom?access_token=
# 請求參數(shù)示例: json
{
"roomId": 6474,
"goodsId" : 1
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| roomId | Number | 是 | 房間ID |
| goodsId | Number | 是 | 商品ID |
# 正確返回示例
{
"errcode": 0 // 0:成功
}
# 23.推送商品
# 接口說明
推送商品
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/goods/push?access_token=
# 請求參數(shù)示例: json
{
"roomId": 6474,
"goodsId" : 1
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| roomId | Number | 是 | 房間ID |
| goodsId | Number | 是 | 商品ID |
# 正確返回示例
{
"errcode": 0 // 0:成功
}
# 24.商品排序
# 接口說明
直播間商品排序
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/goods/sort?access_token=
# 請求參數(shù)示例: json
{
"roomId": 6474,
"goods" : [{"goodsId":"123"}, {"goodsId":"234"}]
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| roomId | Number | 是 | 房間ID |
| goods | Array<Object> | 是 | 商品ID列表 |
# 正確返回示例
{
"errcode": 0 // 0:成功
}
# 25.下載商品講解視頻
# 接口說明
下載商品講解視頻
# 調(diào)用頻率
調(diào)用額度:10000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/goods/getVideo?access_token=
# 請求參數(shù)示例: json
{
"roomId": 6474,
"goodsId" : 1
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| roomId | Number | 是 | 房間ID |
| goodsId | Number | 是 | 商品ID |
# 正確返回示例
{
"url": "xxx", // 講解鏈接
"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)?攔截(當前房間狀態(tài)不允許此操作)
300024:商品不存在
300025:商品審核未通過
300026:房間商品數(shù)量已經(jīng)滿額
300027:導入商品失敗
300028:房間名稱違規(guī)
300029:主播昵稱違規(guī)
300030:主播微信號不合法
300031:直播間封面圖不合規(guī)
300032:直播間分享圖違規(guī)
300033:添加商品超過直播間上限
300034:主播微信昵稱長度不符合要求
300035:主播微信號不存在
300036:主播微信號未實名認證
300037:購物直播頻道封面圖不合規(guī)
300038:未在小程序管理后臺配置客服
300039:主播副號微信號不合法
300040:名稱含有非限定字符(含有特殊字符)
300041:創(chuàng)建者微信號不合法
300042:推流中禁止編輯房間
300043:每天只允許一場直播開啟關注
300044:商品沒有講解視頻
300045:講解視頻未生成
300046:講解視頻生成失敗
300047:已有商品正在推送,請稍后再試
300048:拉取商品列表失敗
300049:商品推送過程中不允許上下架
300050:排序商品列表為空
300051:解析JSON出錯
300052:已下架的商品無法推送
300053:直播間未添加此商品
500001:副號不合規(guī)
500002:副號未實名
500003:已經(jīng)設置過副號了,不能重復設置
500004:不能設置重復的副號
500005:副號不能和主號重復
600001:用戶已被添加為小助手
600002:找不到用戶
9410000: 直播間列表為空
9410001: 獲取房間失敗
9410002: 獲取商品失敗
9410003: 獲取回放失敗