# 创建直播间

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：createRoom

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

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 调用方法：liveBroadcast.createRoom

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

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

- 该接口所属的权限集 id 为：52

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "name",
    "类型": "string",
    "必填": "是",
    "说明": "直播间名字，最短3个汉字，最长17个汉字，1个汉字相当于2个字符"
  },
  {
    "参数名": "coverImg",
    "类型": "string",
    "必填": "是",
    "说明": "背景图，填入mediaID（mediaID获取后，三天内有效）；图片mediaID的获取，请参考[新增临时素材](/miniprogram/dev/server/API/kf-mgnt/kf-message/api_uploadtempmedia)；直播间背景图，图片规则：建议像素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的获取，请参考[新增临时素材](/miniprogram/dev/server/API/kf-mgnt/kf-message/api_uploadtempmedia)；直播间分享图，图片规则：建议像素800*640，大小不超过1M；"
  },
  {
    "参数名": "feedsImg",
    "类型": "string",
    "必填": "是",
    "说明": "购物直播频道封面图，填入mediaID（mediaID获取后，三天内有效）；图片mediaID的获取，请参考[新增临时素材](/miniprogram/dev/server/API/kf-mgnt/kf-message/api_uploadtempmedia)；购物直播频道封面图，图片规则：建议像素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：关闭】 默认关闭客服（直播开始后允许开启）"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "roomId",
    "类型": "number",
    "说明": "房间ID"
  },
  {
    "参数名": "qrcode_url",
    "类型": "string",
    "说明": "[小程序直播](https://res.wx.qq.com/op_res/9rSix1dhHfK4rR049JL0PHJ7TpOvkuZ3mE0z7Ou_Etvjf-w1J_jVX0rZqeStLfwh)小程序码"
  }
]
```

## 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. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "-1",
    "错误描述": "system error",
    "解决方案": "系统繁忙，此时请开发者稍候再试"
  },
  {
    "错误码": "1007",
    "错误描述": "get no data",
    "解决方案": "未获取到数据"
  },
  {
    "错误码": "40001",
    "错误描述": "invalid 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. 适用范围

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