# 创建直播间

调试诊断

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:createRoom

调用此接口创建直播间,创建成功后将在直播间列表展示。

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 调用方法:liveBroadcast.createRoom

  • 出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:52

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
namestring直播间名字,最短3个汉字,最长17个汉字,1个汉字相当于2个字符
coverImgstring背景图,填入mediaID(mediaID获取后,三天内有效);图片mediaID的获取,请参考新增临时素材;直播间背景图,图片规则:建议像素1080*1920,大小不超过2M
startTimenumber直播计划开始时间(开播时间需要在当前时间的10分钟后 并且 开始时间不能在 6 个月后)
endTimenumber直播计划结束时间(开播时间和结束时间间隔不得短于30分钟,不得超过24小时)
anchorNamestring主播昵称,最短2个汉字,最长15个汉字,1个汉字相当于2个字符
anchorWechatstring主播微信号,如果未实名认证,需要先前往小程序直播小程序进行实名验证
subAnchorWechatstring主播副号微信号,如果未实名认证,需要先前往小程序直播小程序进行实名验证
createrWechatstring创建者微信号,不传入则此直播间所有成员可见。传入则此房间仅创建者、管理员、超管、直播间主播可见
shareImgstring分享图,填入mediaID(mediaID获取后,三天内有效);图片mediaID的获取,请参考新增临时素材;直播间分享图,图片规则:建议像素800*640,大小不超过1M;
feedsImgstring购物直播频道封面图,填入mediaID(mediaID获取后,三天内有效);图片mediaID的获取,请参考新增临时素材;购物直播频道封面图,图片规则:建议像素800*800,大小不超过100KB;
isFeedsPublicnumber是否开启官方收录 【1: 开启,0:关闭】,默认开启收录
typenumber直播间类型 【1: 推流,0:手机直播】
closeLikenumber是否关闭点赞 【0:开启,1:关闭】(若关闭,观众端将隐藏点赞按钮,直播开始后不允许开启)
closeGoodsnumber是否关闭货架 【0:开启,1:关闭】(若关闭,观众端将隐藏商品货架,直播开始后不允许开启)
closeCommentnumber是否关闭评论 【0:开启,1:关闭】(若关闭,观众端将隐藏评论入口,直播开始后不允许开启)
closeReplaynumber是否关闭回放 【0:开启,1:关闭】默认关闭回放(直播开始后允许开启)
closeSharenumber是否关闭分享 【0:开启,1:关闭】默认开启分享(直播开始后不允许修改)
closeKfnumber是否关闭客服 【0:开启,1:关闭】 默认关闭客服(直播开始后允许开启)

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
roomIdnumber房间ID
qrcode_urlstring小程序直播小程序码

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{ 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 关闭 }

返回示例

{ "roomId": 33, //房间ID "errcode": 0, // 当主播微信号没有在 “小程序直播“ 小程序实名认证 返回该字段 "qrcode_url": "https://res.wx.qq.com/op_res/9rSix1dhHfK4rR049JL0PHJ7TpOvkuZ3mE0z7Ou_Etvjf-w1J_jVX0rZqeStLfwh" }

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述解决方案
-1system error系统繁忙,此时请开发者稍候再试
1007get no data未获取到数据
40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口
200002参数错误
300002名称长度不符合规则
300028房间名称违规
300031直播间封面图不合规
300032直播间分享图违规
300034主播微信昵称长度不符合要求
300036主播微信号未实名认证
300037购物直播频道封面图不合规
300038未在小程序管理后台配置客服
300039主播副号微信号不合法
300040名称含有非限定字符(含有特殊字符)
300041创建者微信号不合法

# 7. 适用范围

本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。