# 【小程序直播】直播间管理接口
名称 | 功能说明 |
---|---|
创建直播间 | 该接口可直接创建直播间,创建成功后直播间将在直播间列表展示 |
获取直播房间列表 | 该接口可获取直播房间列表 |
获取直播间回放 | 该接口可在直播结束后拿到回放源视频 |
直播间导入商品 | 调用此接口往指定直播间导入已入库的商品 |
删除直播间 | 删除直播间 |
编辑直播间 | 编辑直播间 |
获取直播间推流地址 | 获取直播间推流地址 |
获取直播间分享二维码 | 获取直播间分享二维码 |
添加管理直播间小助手 | 添加管理直播间小助手 |
修改管理直播间小助手 | 修改管理直播间小助手 |
删除管理直播间小助手 | 删除管理直播间小助手 |
查询管理直播间小助手 | 查询管理直播间小助手 |
添加主播副号 | 添加主播副号 |
修改主播副号 | 修改主播副号 |
删除主播副号 | 删除主播副号 |
获取主播副号 | 获取主播副号 |
开启/关闭直播间官方收录 | 开启/关闭直播间官方收录 |
开启/关闭回放功能 | 开启/关闭回放功能 |
开启/关闭客服功能 | 开启/关闭客服功能 |
开启/关闭直播间全局禁言 | 开启/关闭直播间全局禁言 |
上下架商品 | 上下架商品 |
删除商品 | 删除商品 |
推送商品 | 推送商品 |
商品排序 | 商品排序 |
下载商品讲解视频 | 下载商品讲解视频 |
# 一、简介
直播间管理接口,是小程序直播提供给开发者对直播房间进行批量操作的接口能力。 开发者可以创建直播间、获取直播间信息、获取直播间回放以及往直播间导入商品。
# 二、接口文档
# 1.创建直播间
# 接口说明:
调用此接口创建直播间,创建成功后将在直播间列表展示
# 调用频率
调用额度:10000次/一天
# 请求方式
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/create?access_token=
# 请求参数示例: json
{
name: "测试直播房间1", // 房间名字
coverImg: "", // 通过 uploadfile 上传,填写 mediaID
startTime: 1588237130, // 开始时间
endTime: 1588237130 , // 结束时间
anchorName: "zefzhang1", // 主播昵称
anchorWechat: "WxgQiao_04", // 主播微信号
subAnchorWechat: "WxgQiao_03", // 主播副号微信号
createrWechat: 'test_creater', // 创建者微信号
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 关闭
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
name | String | 是 | 直播间名字,最短3个汉字,最长17个汉字,1个汉字相当于2个字符 |
coverImg | String | 是 | 背景图,填入mediaID(mediaID获取后,三天内有效);图片mediaID的获取,请参考以下文档: https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html;直播间背景图,图片规则:建议像素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 | 否 | 创建者微信号,不传入则此直播间所有成员可见。传入则此房间仅创建者、管理员、超管、直播间主播可见 |
shareImg | String | 是 | 分享图,填入mediaID(mediaID获取后,三天内有效);图片mediaID的获取,请参考以下文档: https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html;直播间分享图,图片规则:建议像素800*640,大小不超过1M; |
feedsImg | String | 是 | 购物直播频道封面图,填入mediaID(mediaID获取后,三天内有效);图片mediaID的获取,请参考以下文档: https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html; 购物直播频道封面图,图片规则:建议像素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,
// 当主播微信号没有在 “小程序直播“ 小程序实名认证 返回该字段
"qrcode_url": "https://res.wx.qq.com/op_res/9rSix1dhHfK4rR049JL0PHJ7TpOvkuZ3mE0z7Ou_Etvjf-w1J_jVX0rZqeStLfwh"
}
# 返回参数含义
参数 | 说明 |
---|---|
roomId | 房间ID |
qrcode_url | "小程序直播" 小程序码 |
# 2.获取直播间列表
# 接口说明
调用此接口获取直播间列表及直播间信息
# 调用频率
调用额度:100000次/一天(与获取回放接口共用次数)
# 请求方式
POST
# 请求URL
https://api.weixin.qq.com/wxa/business/getliveinfo?access_token=
# 请求参数示例: json
{
"start": 0, // 起始拉取房间,start = 0 表示从第 1 个房间开始拉取
"limit": 10 // 每次拉取的个数上限,不要设置过大,建议 100 以内
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
start | Number | 是 | 起始房间,0表示从第1个房间开始拉取 |
limit | Number | 是 | 每次拉取的房间数量,建议100以内 |
# 正确返回示例
{
"errcode": 0, // 错误码,0代表成功,1代表未创建直播间
"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:价格区间(price字段为左边界,price2字段为右边界,price和price2必传) 3:显示折扣价(price字段为原价,price2字段为现价, 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", // 创建者openid
"feeds_img": "XXX" // 官方收录封面
}]
}
# 返回参数含义
房间参数
参数 | 说明 |
---|---|
name | 直播间名称 |
roomid | 直播间ID |
cover_img | 直播间背景图链接 |
share_img | 直播间分享图链接 |
live_status | 直播间状态。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 | 创建者openid |
feeds_img | 官方收录封面 |
total | 拉取房间总数 |
商品参数
参数 | 说明 |
---|---|
cover_img | 商品封面图链接 |
url | 商品小程序路径 |
price | 商品价格(分) |
name | 商品名称 |
price2 | 商品价格,使用方式看price_type |
price_type | 价格类型,1:一口价(只需要传入price,price2不传) 2:价格区间(price字段为左边界,price2字段为右边界,price和price2必传) 3:显示折扣价(price字段为原价,price2字段为现价, price和price2必传) |
goods_id | 商品id |
third_party_appid | 第三方商品appid ,当前小程序商品则为空 |
# 3.获取直播间回放
# 接口说明
调用接口获取已结束直播间的回放源视频(一般在直播结束后10分钟内生成,源视频无评论等内容)
# 调用频率
调用额度:100000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxa/business/getliveinfo?access_token=
# 请求参数示例: json
{
"action": "get_replay",
"room_id": 354,
"start": 0,
"limit": 10
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
action | String | 是 | 获取回放 |
room_id | Number | 是 | 直播间ID |
start | Number | 是 | 起始拉取视频,0表示从第一个视频片段开始拉取 |
limit | Number | 是 | 每次拉取的数量,建议100以内 |
# 正确返回示例
{
"live_replay":[{
"expire_time":"",
"create_time":"",
"media_url":""
}],
"errcode": 0,
"total": 1,
"errmsg":"ok"
}
# 返回参数含义
参数 | 说明 |
---|---|
expire_time | 回放视频url过期时间 |
create_time | 回放视频创建时间 |
media_url | 回放视频链接 |
total | 回放视频片段个数 |
# 4.直播间导入商品
# 接口说明
调用接口往指定直播间导入已入库的商品
# 调用频率
调用额度:10000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/addgoods?access_token=
# 请求参数示例: json
{
"ids": [1150, 1111], // 数组列表,可传入多个,里面填写 商品 ID
"roomId": 2554
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
ids | Array<Number> | 是 | 数组列表,可传入多个,里面填写 商品 ID |
roomId | Number | 是 | 房间ID |
# 正确返回示例
{
"errcode": 0 // 0:成功
}
# 5.删除直播间
# 接口说明
删除直播间
# 调用频率
调用额度:10000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/deleteroom?access_token=
# 请求参数示例: json
{
"id" : 6491
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
id | Number | 是 | 房间ID |
# 正确返回示例
{
"errcode": 0 // 0:成功
}
# 6.编辑直播间
# 接口说明
编辑直播间
# 调用频率
调用额度:10000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/editroom?access_token=
# 请求参数示例: 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"
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
id | Number | 是 | 直播间id |
name | String | 是 | 直播间名字,最短3个汉字,最长17个汉字,1个汉字相当于2个字符 |
coverImg | String | 是 | 背景图,填入mediaID(mediaID获取后,三天内有效);图片mediaID的获取,请参考以下文档: https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html;直播间背景图,图片规则:建议像素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获取后,三天内有效);图片mediaID的获取,请参考以下文档: https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html;直播间分享图,图片规则:建议像素800*640,大小不超过1M; |
feedsImg | String | 是 | 购物直播频道封面图,填入mediaID(mediaID获取后,三天内有效);图片mediaID的获取,请参考以下文档: https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html; 购物直播频道封面图,图片规则:建议像素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.获取直播间推流地址
# 接口说明
获取直播间推流地址
# 调用频率
调用额度:10000次/一天
# 请求方法
GET
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/getpushurl?access_token=
# URL query 参数
{
"roomId" : 6209
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomId | Number | 是 | 房间ID |
# 正确返回示例
{
"pushAddr": "rtmp://wxalivepush.weixin.qq.com/live/wx40f8626ddf43d362-6209?txSecret=5da4f0b7b7a6c25b238311de8c81a65a&txTime=5fc4f631",
"errcode": 0
}
# 8.获取直播间分享二维码
# 接口说明
获取直播间分享二维码
# 调用频率
调用额度:10000次/一天
# 请求方法
GET
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/getsharedcode?access_token=
# URL query 参数
{
"roomId" : 6209,
"params" : encodeURIComponent(JSON.stringify(custom_params))
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomId | Number | 是 | 房间ID |
params | String | 否 | 自定义参数 |
# 正确返回示例
{
"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.添加管理直播间小助手
# 接口说明
添加管理直播间小助手
# 调用频率
调用额度:10000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/addassistant?access_token=
# 请求参数示例: json
{
"roomId": 6474,
"users": [{"username":"testwechat","nickname":"testnick"}]
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomId | Number | 是 | 房间ID |
users | Array<Object> | 是 | 用户数组 |
username | String | 是 | 用户微信号 |
nickname | String | 是 | 用户昵称 |
# 正确返回示例
{
"errcode": 0 // 0:成功
}
# 10.修改管理直播间小助手
# 接口说明
修改管理直播间小助手
# 调用频率
调用额度:10000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/modifyassistant?access_token=
# 请求参数示例: json
{
"roomId": 6474,
"username": "testwechat",
"nickname": "testnick"
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomId | Number | 是 | 房间ID |
username | String | 是 | 用户微信号 |
nickname | String | 是 | 用户微信昵称 |
# 正确返回示例
{
"errcode": 0 // 0:成功
}
# 11.删除管理直播间小助手
# 接口说明
删除管理直播间小助手
# 调用频率
调用额度:10000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/removeassistant?access_token=
# 请求参数示例: json
{
"roomId": 6623,
"username": "testwechat"
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomId | Number | 是 | 房间ID |
username | String | 是 | 用户微信号 |
# 正确返回示例
{
"errcode": 0 // 0:成功
}
# 12.查询管理直播间小助手
# 接口说明
查询管理直播间小助手
# 调用频率
调用额度:10000次/一天
# 请求方法
GET
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/getassistantlist?access_token=
# URL query 参数
{
"roomId" : 6491
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
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
}
# 返回参数含义
参数 | 类型 | 说明 |
---|---|---|
list | Array<Object> | 小助手列表 |
count | Number | 小助手个数 |
maxCount | Number | 小助手最大个数 |
timestamp | Number | 修改时间 |
headimg | String | 头像 |
nickname | String | 昵称 |
alias | String | 微信号 |
openid | String | openid |
# 13.添加主播副号
# 接口说明
添加主播副号
# 调用频率
调用额度:10000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/addsubanchor?access_token=
# 请求参数示例: json
{
"roomId": 6827,
"username": "lintest2"
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomId | Number | 是 | 房间ID |
username | String | 是 | 用户微信号 |
# 正确返回示例
{
"errcode": 0 // 0:成功
}
# 14.修改主播副号
# 接口说明
修改主播副号
# 调用频率
调用额度:10000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/modifysubanchor?access_token=
# 请求参数示例: json
{
"roomId": 6827,
"username": "wechattest"
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomId | Number | 是 | 房间ID |
username | String | 是 | 微信号 |
# 正确返回示例
{
"errcode": 0 // 0:成功
}
# 15.删除主播副号
# 接口说明
删除主播副号
# 调用频率
调用额度:10000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/deletesubanchor?access_token=
# 请求参数示例: json
{
"roomId" : 6491
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomId | Number | 是 | 房间ID |
# 正确返回示例
{
"errcode": 0 // 0:成功
}
# 16.获取主播副号
# 接口说明
获取主播副号
# 调用频率
调用额度:10000次/一天
# 请求方法
GET
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/getsubanchor?access_token=
# URL query 参数
{
"roomId" : 6491
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomId | Number | 是 | 房间ID |
# 正确返回示例
{
"username": "testwechat",
"errcode": 0
}
# 17.开启/关闭直播间官方收录
# 接口说明
开启/关闭直播间官方收录
# 调用频率
调用额度:10000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/updatefeedpublic?access_token=
# 请求参数示例: json
{
"roomId": 6474,
"isFeedsPublic" : 0
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomId | Number | 是 | 房间ID |
isFeedsPublic | Number | 是 | 是否开启官方收录 【1: 开启,0:关闭】 |
# 正确返回示例
{
"errcode": 0 // 0:成功
}
# 18.开启/关闭回放功能
# 接口说明
开启/关闭回放功能
# 调用频率
调用额度:10000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/updatereplay?access_token=
# 请求参数示例: json
{
"roomId": 6474,
"closeReplay" : 0
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomId | Number | 是 | 房间ID |
closeReplay | Number | 是 | 是否关闭回放 【0:开启,1:关闭】 |
# 正确返回示例
{
"errcode": 0 // 0:成功
}
# 19.开启/关闭客服功能
# 接口说明
开启/关闭客服功能
# 调用频率
调用额度:10000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/updatekf?access_token=
# 请求参数示例: json
{
"roomId" : 6491,
"closeKf" : 0
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomId | Number | 是 | 房间ID |
closeKf | Number | 是 | 是否关闭客服 【0:开启,1:关闭】 |
# 正确返回示例
{
"errcode": 0 // 0:成功
}
# 20.开启/关闭直播间全局禁言
# 接口说明
开启/关闭直播间全局禁言
# 调用频率
调用额度:10000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/room/updatecomment?access_token=
# 请求参数示例: json
{
"roomId": 6474,
"banComment" : 1
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
id | Number | 是 | 房间ID |
banComment | Number | 是 | 1-禁言,0-取消禁言 |
# 正确返回示例
{
"errcode": 0 // 0:成功
}
# 21.上下架商品
# 接口说明
上下架商品
# 调用频率
调用额度:10000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/goods/onsale?access_token=
# 请求参数示例: json
{
"roomId": 6474,
"goodsId" : 1,
"onSale": 0
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomId | Number | 是 | 房间ID |
goodsId | Number | 是 | 商品ID |
onSale | Number | 是 | 上下架 【0:下架,1:上架】 |
# 正确返回示例
{
"errcode": 0 // 0:成功
}
# 22.删除商品
# 接口说明
删除直播间商品
# 调用频率
调用额度:10000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/goods/deleteInRoom?access_token=
# 请求参数示例: json
{
"roomId": 6474,
"goodsId" : 1
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomId | Number | 是 | 房间ID |
goodsId | Number | 是 | 商品ID |
# 正确返回示例
{
"errcode": 0 // 0:成功
}
# 23.推送商品
# 接口说明
推送商品
# 调用频率
调用额度:10000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/goods/push?access_token=
# 请求参数示例: json
{
"roomId": 6474,
"goodsId" : 1
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomId | Number | 是 | 房间ID |
goodsId | Number | 是 | 商品ID |
# 正确返回示例
{
"errcode": 0 // 0:成功
}
# 24.商品排序
# 接口说明
直播间商品排序
# 调用频率
调用额度:10000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/goods/sort?access_token=
# 请求参数示例: json
{
"roomId": 6474,
"goods" : [{"goodsId":"123"}, {"goodsId":"234"}]
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomId | Number | 是 | 房间ID |
goods | Array<Object> | 是 | 商品ID列表 |
# 正确返回示例
{
"errcode": 0 // 0:成功
}
# 25.下载商品讲解视频
# 接口说明
下载商品讲解视频
# 调用频率
调用额度:10000次/一天
# 请求方法
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/goods/getVideo?access_token=
# 请求参数示例: json
{
"roomId": 6474,
"goodsId" : 1
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomId | Number | 是 | 房间ID |
goodsId | Number | 是 | 商品ID |
# 正确返回示例
{
"url": "xxx", // 讲解链接
"errcode": 0 // 0:成功
}
# 附录:错误码
-1:系统错误
1:未创建直播间
1003:商品id不存在
47001:入参格式不符合规范
200002:入参错误
300001:禁止创建/更新商品 或 禁止编辑&更新房间
300002:名称长度不符合规则
300006:图片上传失败(如:mediaID过期)
300022:此房间号不存在
300023:房间状态 拦截(当前房间状态不允许此操作)
300024:商品不存在
300025:商品审核未通过
300026:房间商品数量已经满额
300027:导入商品失败
300028:房间名称违规
300029:主播昵称违规
300030:主播微信号不合法
300031:直播间封面图不合规
300032:直播间分享图违规
300033:添加商品超过直播间上限
300034:主播微信昵称长度不符合要求
300035:主播微信号不存在
300036:主播微信号未实名认证
300037:购物直播频道封面图不合规
300038:未在小程序管理后台配置客服
300039:主播副号微信号不合法
300040:名称含有非限定字符(含有特殊字符)
300041:创建者微信号不合法
300042:推流中禁止编辑房间
300043:每天只允许一场直播开启关注
300044:商品没有讲解视频
300045:讲解视频未生成
300046:讲解视频生成失败
300047:已有商品正在推送,请稍后再试
300048:拉取商品列表失败
300049:商品推送过程中不允许上下架
300050:排序商品列表为空
300051:解析JSON出错
300052:已下架的商品无法推送
300053:直播间未添加此商品
500001:副号不合规
500002:副号未实名
500003:已经设置过副号了,不能重复设置
500004:不能设置重复的副号
500005:副号不能和主号重复
600001:用户已被添加为小助手
600002:找不到用户
9410000: 直播间列表为空
9410001: 获取房间失败
9410002: 获取商品失败
9410003: 获取回放失败