小程序直播 /直播间管理 /创建直播间 # 创建直播间 > 接口应在服务器端调用,详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。 > 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`(最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)),`wx-server-sdk` >= `0.4.0` ## 接口说明 ### 接口英文名 createRoom ### 功能描述 调用此接口创建直播间,创建成功后将在直播间列表展示。 ## 调用方式 ### HTTPS 调用 ```text POST https://api.weixin.qq.com/wxaapi/broadcast/room/create?access_token=ACCESS_TOKEN ``` ### 云调用 - 出入参和 HTTPS 调用相同,调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html) - 接口方法为: openapi.liveBroadcast.createRoom ### 第三方调用 - 调用方式以及出入参和 HTTPS 相同,仅是调用的 token 不同 - 该接口所属的权限集 id 为:52 - 服务商获得其中之一权限集授权后,可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用 #### 请求参数含义 | **参数** | **类型** | **必填** | **说明** | | :-------------- | :------- | :------- | :----------------------------------------------------------- | | 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 | 房间ID | | qrcode_url | "小程序直播" 小程序码 | ## 调用示例 > 示例说明: HTTPS请求示例 ### 请求数据示例 ```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 关闭 } ``` ### 返回数据示例 ```json { "roomId": 33, //房间ID "errcode": 0, // 当主播微信号没有在 “小程序直播“ 小程序实名认证 返回该字段 "qrcode_url": "https://res.wx.qq.com/op_res/9rSix1dhHfK4rR049JL0PHJ7TpOvkuZ3mE0z7Ou_Etvjf-w1J_jVX0rZqeStLfwh" } ``` ### 错误码 | 错误码 | 错误码取值 | 解决方案 | | :----- | :------------------------------------------------------ | :----------------------------------------------------------- | | -1 | system error | 系统繁忙,此时请开发者稍候再试 | | 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 | | 200002 | 参数错误 | | | 300002 | 名称长度不符合规则 | | | 300028 | 房间名称违规 | | | 300031 | 直播间封面图不合规 | | | 300032 | 直播间分享图违规 | | | 300034 | 主播微信昵称长度不符合要求 | | | 300036 | 主播微信号未实名认证 | | | 300037 | 购物直播频道封面图不合规 | | | 300039 | 主播副号微信号不合法 | | | 300040 | 名称含有非限定字符(含有特殊字符) | | | 300041 | 创建者微信号不合法 | |