微信小程序 服务端接口·直播间接口
【小程序直播】直播间管理接口名称 功能说明
创建直播间 该接口可直接创建直播间，创建成功后直播间将在直播间列表展示
获取直播房间列表 该接口可获取直播房间列表
获取直播间回放 该接口可在直播结束后拿到回放源视频
直播间导入商品 调用此接口往指定直播间导入已入库的商品
一、简介
直播间管理接口，是小程序直播提供给开发者对直播房间进行批量操作的接口能力。 开发者可以创建直播间、获取直播间信息、获取直播间回放以及往直播间导入商品。
二、接口文档
1.创建直播间
接口说明：
调用此接口创建直播间，创建成功后将在直播间列表展示
调用频率
调用额度：10000次/一天
请求方式
POST
请求URL
[url]https://api.weixin.qq.com/wxaapi/broadcast/room/create?access_token=[/url]
请求参数示例： json
{
name: "测试直播房间1", // 房间名字
coverImg: "", // 通过 uploadfile 上传，填写 mediaID
startTime: 1588237130, // 开始时间
endTime: 1588237130 , // 结束时间
anchorName: "zefzhang1", // 主播昵称
anchorWechat: "WxgQiao_04", // 主播微信号
shareImg: "" , //通过 uploadfile 上传，填写 mediaID
type: 1 , // 直播类型，1 推流 0 手机直播
screenType: 0, // 1：横屏 0：竖屏
closeLike: 0 , // 是否 关闭点赞 1 关闭
closeGoods: 0, // 是否 关闭商品货架，1：关闭
closeComment: 0 // 是否开启评论，1：关闭
}
请求参数含义
参数 类型 必填 说明
name String 是 直播间名字，最短3个汉字，最长17个汉字，1个汉字相当于2个字符
coverImg String 是 背景图，填入mediaID（mediaID获取后，三天内有效）；图片mediaID的获取，请参考以下文档： [url]https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html[/url]；直播间背景图，图片规则：建议像素1080*1920，大小不超过2M
startTime Number 是 直播计划开始时间（开播时间需要在当前时间的10分钟后 并且 开始时间不能在 6 个月后）
endTime Number 是 直播计划结束时间（开播时间和结束时间间隔不得短于30分钟，不得超过24小时）
anchorName String 是 主播昵称，最短2个汉字，最长15个汉字，1个汉字相当于2个字符
anchorWechat String 是 主播微信号，如果未实名认证，需要先前往“小程序直播”小程序进行实名验证, 小程序二维码链接：[url]https://res.wx.qq.com/op_res/BbVNeczA1XudfjVqCVoKgfuWe7e3aUhokktRVOqf_F0IqS6kYR--atCpVNUUC3zr[/url]
subAnchorWechat String 否 主播副号微信号，如果未实名认证，需要先前往“小程序直播”小程序进行实名验证, 小程序二维码链接：[url]https://res.wx.qq.com/op_res/BbVNeczA1XudfjVqCVoKgfuWe7e3aUhokktRVOqf_F0IqS6kYR--atCpVNUUC3zr[/url]
createrWechat String 否 创建者微信号
shareImg String 是 分享图，填入mediaID（mediaID获取后，三天内有效）；图片mediaID的获取，请参考以下文档： [url]https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html[/url]；直播间分享图，图片规则：建议像素800*640，大小不超过1M；
feedsImg String 否 购物直播频道封面图，填入mediaID（mediaID获取后，三天内有效）；图片mediaID的获取，请参考以下文档： [url]https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html[/url]; 购物直播频道封面图，图片规则：建议像素800*800，大小不超过100KB；
isFeedsPublic Number 否 是否开启官方收录 【1: 开启，0：关闭】，默认开启收录
type Number 是 直播间类型 【1: 推流，0：手机直播】
screenType Number 是 横屏、竖屏 【1：横屏，0：竖屏】（横屏：视频宽高比为16:9、4:3、1.85:1 ；竖屏：视频宽高比为9:16、2:3）
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
}
返回参数含义
参数 说明
roomId 房间ID
qrcode_url "小程序直播" 小程序码
2.获取直播间列表
接口说明
调用此接口获取直播间列表及直播间信息
调用频率
调用额度：100000次/一天（与获取回放接口共用次数）
请求方式
POST
请求URL
[url]https://api.weixin.qq.com/wxa/business/getliveinfo?access_token=[/url]
请求参数示例： json
{
"start": 0, // 起始拉取房间，start = 0 表示从第 1 个房间开始拉取
"limit": 10 // 每次拉取的个数上限，不要设置过大，建议 100 以内
}
请求参数含义
参数 类型 必填 说明
start Number 是 起始房间，0表示从第1个房间开始拉取
limit Number 是 每次拉取的房间数量，建议100以内
正确返回示例
{
"errcode": 0, // 错误码，0代表成功，1代表未创建直播间
"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
}]
}
返回参数含义
房间参数
参数 说明
name 直播间名称
roomid 直播间ID
cover_img 直播间背景图链接
share_img 直播间分享图链接
live_status 直播间状态。101：直播中，102：未开始，103已结束，104禁播，105：暂停，106：异常，107：已过期
start_time 直播间开始时间，列表按照start_time降序排列
end_time 直播计划结束时间
anchor_name 主播名
total 拉取房间总数
商品参数
参数 说明
cover_img 商品封面图链接
url 商品小程序路径
price 商品价格
name 商品名称
3.获取直播间回放
接口说明
调用接口获取已结束直播间的回放源视频（一般在直播结束后10分钟内生成，源视频无评论等内容）
调用频率
调用额度：100000次/一天
请求方法
POST
请求URL
[url]https://api.weixin.qq.com/wxa/business/getliveinfo?access_token=[/url]
请求参数示例： 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
[url]https://api.weixin.qq.com/wxaapi/broadcast/room/addgoods?access_token=[/url]
请求参数示例： json
{
"ids": [1150, 1111], // 数组列表，可传入多个，里面填写 商品 ID
"roomId": 2554
}
请求参数含义
参数 类型 必填 说明
ids Array<Number> 是 数组列表，可传入多个，里面填写 商品 ID
roomId Number 是 房间ID
正确返回示例
{
"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：创建者微信号不合法
9410000: 直播间列表为空
9410001: 获取房间失败
9410002: 获取商品失败
9410003: 获取回放失败
页:
[1]