# 编辑直播间
接口应在服务器端调用,详细说明参见服务端API。
本接口支持云调用。需开发者工具版本 >=
1.02.1904090
(最新稳定版下载),wx-server-sdk
>=0.4.0
# 接口说明
# 接口英文名
editRoom
# 功能描述
该接口用于编辑直播间
# 注意事项
调用额度:10000次/一天
# 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxaapi/broadcast/room/editroom?access_token=ACCESS_TOKEN
# 云调用
出入参和HTTPS调用相同,调用方式可查看云调用说明文档
接口方法为: openapi.liveBroadcast.editRoom
# 第三方调用
调用方式以及出入参和HTTPS相同,仅是调用的token不同
该接口所属的权限集id为:52
服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
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 | number | 返回码 |
# 调用示例
示例说明: HTTPS请求示例
# 请求数据示例
{
"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"
}
# 返回数据示例
{
"errcode": 0,
"errmsg": "ok"
}
# 错误码
错误码 | 错误码取值 | 解决方案 |
---|---|---|
-1 | system error | 系统繁忙,此时请开发者稍候再试 |
40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
200002 | 参数错误 | |
300002 | 名称长度不符合规则 | |
300022 | 此房间号不存在 | |
300023 | 房间状态 拦截(当前房间状态不允许此操作) | |
300030 | 主播微信号不合法 | |
300037 | 购物直播频道封面图不合规 | |
300031 | 直播间封面图不合规 | |
300032 | 直播间分享图违规 |