top.codewood.wx.mnp.api

类 WxMnpLiveApi

java.lang.Object

top.codewood.wx.common.api.WxBaseHttpApi

top.codewood.wx.mnp.api.WxMnpLiveApi

public class WxMnpLiveApi
extends WxBaseHttpApi

小程序直播-直播间接口 参考文档

构造器概要

构造器

构造器和说明
WxMnpLiveApi()

方法概要

限定符和类型	方法和说明
void	addAssistant(String accessToken, Integer roomId, List<WxMnpLiveAssistant> users) 添加管理直播间小助手 调用额度：10000次/一天 参考文档
void	addGoodsToRoom(String accessToken, Integer roomId, List<Integer> goodsIds) 直播间导入商品 调用接口往指定直播间导入已入库的商品 调用额度：10000次/一天 参考文档
void	addSubAnchor(String accessToken, Integer roomId, String username) 添加主播副号 调用额度：10000次/一天 参考文档
WxMnpLiveRoomCreateResult	createRoom(String accessToken, WxMnpLiveRoomCreateRequest request) 创建直播间 调用此接口创建直播间，创建成功后将在直播间列表展 调用额度：10000次/一天 参考文档
void	deleteRoom(String accessToken, Integer roomId) 删除直播间 调用额度：10000次/一天 参考文档
void	deleteSubAnchor(String accessToken, Integer roomId) 删除主播副号 调用额度：10000次/一天 参考文档
void	editRoom(String accessToken, WxMnpLiveRoomCreateRequest request) 编辑直播间 调用额度：10000次/一天 参考文档
static WxMnpLiveApi	getInstance()
String	getPushUrl(String accessToken, Integer roomId) 获取直播间推流地址 调用额度：10000次/一天 参考文档
WxMnpLiveRoomReplayResult	getRoomReplay(String accessToken, Integer roomId, Integer start, Integer limit) 获取直播间回放 调用接口获取已结束直播间的回放源视频（一般在直播结束后10分钟内生成，源视频无评论等内容） 调用额度：100000次/一天 参考文档
WxMnpLiveGetShareCodeResult	getShareCode(String accessToken, Integer roomId, Map<String,Object> customParams) 获取直播间分享二维码 调用额度：10000次/一天 参考文档
String	getSubAnchor(String accessToken, Integer roomId) 获取主播副号 调用额度：10000次/一天 参考文档
void	goodsDeleteInRoom(String accessToken, Integer roomId, Integer goodsId) 删除直播间商品 调用额度：10000次/一天 参考文档
void	goodsOnSale(String accessToken, Integer roomId, Integer goodsId, Integer onSale) 上下架商品 调用额度：10000次/一天 参考文档
void	goodsPush(String accessToken, Integer roomId, Integer goodsId) 推送商品 调用额度：10000次/一天 参考文档
void	goodsSort(String accessToken, Integer roomId, List<Integer> goodsIds) 直播间商品排序 调用额度：10000次/一天 参考文档
String	goodsVideo(String accessToken, Integer roomId, Integer goodsId) 下载商品讲解视频 调用额度：10000次/一天 参考文档
WxMnpLiveAssistantListResult	listAssistants(String accessToken, Integer roomId) 查询管理直播间小助手 调用额度：10000次/一天 参考文档
WxMnpLiveRoomListResult	listRooms(String accessToken, Integer start, Integer limit) 获取直播间列表 调用此接口获取直播间列表及直播间信息 调用额度：100000次/一天（与获取回放接口共用次数） 参考文档
void	modifyAssistant(String accessToken, Integer roomId, String username, String nickname) 修改管理直播间小助手 调用额度：10000次/一天 参考文档
void	modifySubAnchor(String accessToken, Integer roomId, String username) 修改主播副号 调用额度：10000次/一天 参考文档
void	removeAssistant(String accessToken, Integer roomId, String username) 删除管理直播间小助手 调用额度：10000次/一天 参考文档
void	updateComment(String accessToken, Integer roomId, Integer banComment) 开启/关闭直播间全局禁言 调用额度：10000次/一天 参考文档
void	updateFeedPublic(String accessToken, Integer roomId, Integer isFeedsPublic) 开启/关闭直播间官方收录 调用额度：10000次/一天 参考文档
void	updateKf(String accessToken, Integer roomId, Integer closeKf) 开启/关闭客服功能 调用额度：10000次/一天 参考文档
void	updateReplay(String accessToken, Integer roomId, Integer closeReplay) 开启/关闭回放功能 调用额度：10000次/一天 参考文档

从类继承的方法 top.codewood.wx.common.api.WxBaseHttpApi

get, getInputStream, post, post, postInputStream, upload, upload

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

WxMnpLiveApi

public WxMnpLiveApi()

方法详细资料

getInstance

public static WxMnpLiveApi getInstance()

createRoom

public WxMnpLiveRoomCreateResult createRoom(String accessToken,
                                            WxMnpLiveRoomCreateRequest request)

创建直播间 调用此接口创建直播间，创建成功后将在直播间列表展 调用额度：10000次/一天 参考文档

参数:

request -

返回:

listRooms

public WxMnpLiveRoomListResult listRooms(String accessToken,
                                         Integer start,
                                         Integer limit)

获取直播间列表 调用此接口获取直播间列表及直播间信息 调用额度：100000次/一天（与获取回放接口共用次数） 参考文档

参数:

accessToken -

start - 起始房间，0表示从第1个房间开始拉取

limit - 每次拉取的房间数量，建议100以内

返回:

getRoomReplay

public WxMnpLiveRoomReplayResult getRoomReplay(String accessToken,
                                               Integer roomId,
                                               Integer start,
                                               Integer limit)

获取直播间回放 调用接口获取已结束直播间的回放源视频（一般在直播结束后10分钟内生成，源视频无评论等内容） 调用额度：100000次/一天 参考文档

参数:

accessToken -

roomId - 直播间ID

start - 起始拉取视频，0表示从第一个视频片段开始拉取

limit - 每次拉取的数量，建议100以内

返回:

addGoodsToRoom

public void addGoodsToRoom(String accessToken,
                           Integer roomId,
                           List<Integer> goodsIds)

直播间导入商品 调用接口往指定直播间导入已入库的商品 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId - 房间ID

goodsIds - 数组列表，可传入多个，里面填写 商品 ID

deleteRoom

public void deleteRoom(String accessToken,
                       Integer roomId)

删除直播间 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId - 房间ID

editRoom

public void editRoom(String accessToken,
                     WxMnpLiveRoomCreateRequest request)

编辑直播间 调用额度：10000次/一天 参考文档

参数:

accessToken -

request -

getPushUrl

public String getPushUrl(String accessToken,
                         Integer roomId)

获取直播间推流地址 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId - 房间ID

返回:

直播间推流地址

getShareCode

public WxMnpLiveGetShareCodeResult getShareCode(String accessToken,
                                                Integer roomId,
                                                Map<String,Object> customParams)

获取直播间分享二维码 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId - 房间ID

customParams - 自定义参数, 可以为null

返回:

addAssistant

public void addAssistant(String accessToken,
                         Integer roomId,
                         List<WxMnpLiveAssistant> users)

添加管理直播间小助手 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId - 房间ID

users - 用户数组 ex: "users": [{"username":"testwechat","nickname":"testnick"}]

modifyAssistant

public void modifyAssistant(String accessToken,
                            Integer roomId,
                            String username,
                            String nickname)

修改管理直播间小助手 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId - 房间ID

username - 用户微信号

nickname - 用户微信昵称

removeAssistant

public void removeAssistant(String accessToken,
                            Integer roomId,
                            String username)

删除管理直播间小助手 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId - 房间ID

username - 用户微信号

listAssistants

public WxMnpLiveAssistantListResult listAssistants(String accessToken,
                                                   Integer roomId)

查询管理直播间小助手 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId -

addSubAnchor

public void addSubAnchor(String accessToken,
                         Integer roomId,
                         String username)

添加主播副号 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId -

username -

modifySubAnchor

public void modifySubAnchor(String accessToken,
                            Integer roomId,
                            String username)

修改主播副号 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId - 房间ID

username - 微信号

deleteSubAnchor

public void deleteSubAnchor(String accessToken,
                            Integer roomId)

删除主播副号 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId - 房间ID

getSubAnchor

public String getSubAnchor(String accessToken,
                           Integer roomId)

获取主播副号 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId - 房间ID

返回:

主播副号微信号

updateFeedPublic

public void updateFeedPublic(String accessToken,
                             Integer roomId,
                             Integer isFeedsPublic)

开启/关闭直播间官方收录 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId - 房间ID

isFeedsPublic - 是否开启官方收录 【1: 开启，0：关闭】

updateReplay

public void updateReplay(String accessToken,
                         Integer roomId,
                         Integer closeReplay)

开启/关闭回放功能 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId - 房间ID

closeReplay - 是否关闭回放 【0：开启，1：关闭】

updateKf

public void updateKf(String accessToken,
                     Integer roomId,
                     Integer closeKf)

开启/关闭客服功能 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId - 房间ID

closeKf - 是否关闭客服 【0：开启，1：关闭】

updateComment

public void updateComment(String accessToken,
                          Integer roomId,
                          Integer banComment)

开启/关闭直播间全局禁言 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId - 房间ID

banComment - 1-禁言，0-取消禁言

goodsOnSale

public void goodsOnSale(String accessToken,
                        Integer roomId,
                        Integer goodsId,
                        Integer onSale)

上下架商品 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId -

goodsId -

onSale -

goodsDeleteInRoom

public void goodsDeleteInRoom(String accessToken,
                              Integer roomId,
                              Integer goodsId)

删除直播间商品 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId -

goodsId -

goodsPush

public void goodsPush(String accessToken,
                      Integer roomId,
                      Integer goodsId)

推送商品 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId - 房间ID

goodsId - 商品ID

goodsSort

public void goodsSort(String accessToken,
                      Integer roomId,
                      List<Integer> goodsIds)

直播间商品排序 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId - 房间ID

goodsIds - 商品ID列表

goodsVideo

public String goodsVideo(String accessToken,
                         Integer roomId,
                         Integer goodsId)

下载商品讲解视频 调用额度：10000次/一天 参考文档

参数:

accessToken -

roomId - 房间ID

goodsId - 商品ID

返回:

讲解链接