WxMaLiveService (WxJava - MiniApp Java SDK 4.7.0 API)

所有已知实现类:: WxMaLiveServiceImpl

public interface WxMaLiveService

  直播相关操作接口.
  Created by yjwang on 2020/4/5.

作者:: yjwang

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`boolean`	`addAssistant(Integer roomId, List<WxMaLiveAssistantInfo> users)` 添加管理直播间小助手调用接口往指定直播间添加管理直播间小助手调用频率调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/addassistant?
`boolean`	`addGoodsToRoom(Integer roomId, List<Integer> goodsIds)` 直播间导入商品调用接口往指定直播间导入已入库的商品调用频率调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/addgoods?
`boolean`	`addSubanchor(Integer roomId, String username)` 添加主播副号调用接口添加主播副号调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/addsubanchor?
`WxMaCreateRoomResult`	`createRoom(WxMaLiveRoomInfo roomInfo)` 创建直播间调用此接口创建直播间，创建成功后将在直播间列表展示，调用额度：10000次/一天文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#1 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/create?
`boolean`	`deleteInRoom(Integer roomId, Integer goodsId)` 删除直播间商品调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/goods/deleteInRoom?
`boolean`	`deleteRoom(Integer roomId)` 删除直播间调用额度：10000次/一天文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#5 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/deleteroom?
`boolean`	`deleteSubanchor(Integer roomId)` 删除主播副号调用频率: 10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/deletesubanchor?
`boolean`	`editRoom(WxMaLiveRoomInfo roomInfo)` 编辑直播间调用此接口编辑直播间，调用额度：10000次/一天文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#6 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/editroom?
`List<WxMaAssistantResult.Assistant>`	`getAssistantList(Integer roomId)` 查询直播间小助手查询直播间小助手调用频率调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/getassistantlist?
`WxMaLiveResult`	`getLiveInfo(Integer start, Integer limit)` 获取直播房间列表.
`List<WxMaLiveResult.RoomInfo>`	`getLiveInfos()` 获取所有直播间信息（没有分页直接获取全部）
`WxMaLiveResult`	`getLiveReplay(Integer roomId, Integer start, Integer limit)` 获取直播房间回放数据信息.
`WxMaLiveResult`	`getLiveReplay(String action, Integer roomId, Integer start, Integer limit)` 获取直播房间回放数据信息.
`String`	`getPushUrl(Integer roomId)` 获取直播间推流地址调用额度：10000次/一天文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#7 http请求方式：GET https://api.weixin.qq.com/wxaapi/broadcast/room/getpushurl?
`WxMaLiveSharedCode`	`getSharedCode(Integer roomId, String params)` 获取直播间分享二维码调用额度：10000次/一天文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#8 http请求方式：GET https://api.weixin.qq.com/wxaapi/broadcast/room/getsharedcode?
`String`	`getSubanchor(Integer roomId)` 获取主播副号调用额度：10000次/一天 http请求方式：GET https://api.weixin.qq.com/wxaapi/broadcast/room/getsubanchor?
`String`	`getVideo(Integer roomId, Integer goodsId)` 下载商品讲解视频调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/goods/getVideo?
`boolean`	`modifyAssistant(Integer roomId, String username, String nickname)` 修改直播间小助手昵称调用接口修改直播间小助手昵称调用频率调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/modifyassistant?
`boolean`	`modifySubanchor(Integer roomId, String username)` 修改主播副号调用接口修改主播副号调用频率: 10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/modifyassistant?
`boolean`	`onsale(Integer roomId, Integer goodsId, Integer onSale)` 上下架商品调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/goods/onsale?
`boolean`	`push(Integer roomId, Integer goodsId)` 推送商品调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/goods/push?
`boolean`	`removeAssistant(Integer roomId, String username)` 删除直播间小助手删除直播间小助手调用频率调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/removeassistant?
`boolean`	`sort(Integer roomId, List<Map<String,String>> goods)` 直播间商品排序调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/goods/sort?
`boolean`	`updatecomment(Integer roomId, Integer banComment)` 开启/关闭直播间全局禁言调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/updatecomment?
`boolean`	`updatefeedpublic(Integer roomId, Integer isFeedsPublic)` 开启/关闭直播间官方收录调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/updatefeedpublic?
`boolean`	`updatekf(Integer roomId, Integer closeKf)` 开启/关闭客服功能调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/updatekf?
`boolean`	`updatereplay(Integer roomId, Integer closeReplay)` 开启/关闭回放功能调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/updatereplay?

- 方法详细资料
  - createRoom
```
WxMaCreateRoomResult createRoom(WxMaLiveRoomInfo roomInfo)
                         throws WxErrorException
```
    创建直播间
```
 调用此接口创建直播间，创建成功后将在直播间列表展示，调用额度：10000次/一天
 文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#1
 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/create?access_token=ACCESS_TOKEN
 
```
    参数:
    
    roomInfo - 直播间信息
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - deleteRoom
```
boolean deleteRoom(Integer roomId)
            throws WxErrorException
```
    删除直播间
```
 调用额度：10000次/一天
 文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#5
 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/deleteroom?access_token=ACCESS_TOKEN
 
```
    参数:
    
    roomId - 直播间id
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - editRoom
```
boolean editRoom(WxMaLiveRoomInfo roomInfo)
          throws WxErrorException
```
    编辑直播间
```
 调用此接口编辑直播间，调用额度：10000次/一天
 文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#6
 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/editroom?access_token=ACCESS_TOKEN
 
```
    参数:
    
    roomInfo - 直播间信息
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - getPushUrl
```
String getPushUrl(Integer roomId)
           throws WxErrorException
```
    获取直播间推流地址
```
 调用额度：10000次/一天
 文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#7
 http请求方式：GET https://api.weixin.qq.com/wxaapi/broadcast/room/getpushurl?access_token=ACCESS_TOKEN
 
```
    参数:
    
    roomId - 直播间id
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - getSharedCode
```
WxMaLiveSharedCode getSharedCode(Integer roomId,
                                 String params)
                          throws WxErrorException
```
    获取直播间分享二维码
```
 调用额度：10000次/一天
 文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#8
 http请求方式：GET https://api.weixin.qq.com/wxaapi/broadcast/room/getsharedcode?access_token=ACCESS_TOKEN
 
```
    参数:
    
    roomId - 直播间id
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - getLiveInfo
```
WxMaLiveResult getLiveInfo(Integer start,
                           Integer limit)
                    throws WxErrorException
```
    获取直播房间列表.（分页）
    
    参数:
    
    start - 起始拉取房间，start = 0 表示从第 1 个房间开始拉取
    
    limit - 每次拉取的个数上限，不要设置过大，建议 100 以内
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - getLiveInfos
```
List<WxMaLiveResult.RoomInfo> getLiveInfos()
                                    throws WxErrorException
```
    获取所有直播间信息（没有分页直接获取全部）
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - getLiveReplay
```
WxMaLiveResult getLiveReplay(String action,
                             Integer roomId,
                             Integer start,
                             Integer limit)
                      throws WxErrorException
```
    获取直播房间回放数据信息.
    
    参数:
    
    action - 获取回放
    
    roomId - 直播间 id
    
    start - 起始拉取视频，start = 0 表示从第 1 个视频片段开始拉取
    
    limit - 每次拉取的个数上限，不要设置过大，建议 100 以内
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - getLiveReplay
```
WxMaLiveResult getLiveReplay(Integer roomId,
                             Integer start,
                             Integer limit)
                      throws WxErrorException
```
    获取直播房间回放数据信息.
    获取回放（默认：get_replay）
    
    参数:
    
    roomId - 直播间 id
    
    start - 起始拉取视频，start = 0 表示从第 1 个视频片段开始拉取
    
    limit - 每次拉取的个数上限，不要设置过大，建议 100 以内
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - addGoodsToRoom
```
boolean addGoodsToRoom(Integer roomId,
                       List<Integer> goodsIds)
                throws WxErrorException
```
    直播间导入商品
    调用接口往指定直播间导入已入库的商品调用频率调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/addgoods?access_token=ACCESS_TOKEN
    参数:
    
    roomId - 房间ID
    
    goodsIds - 数组列表，可传入多个，里面填写商品 ID
    
    返回:
    
    导入商品是否成功
    
    抛出:
    
    WxErrorException - .
  - addAssistant
```
boolean addAssistant(Integer roomId,
                     List<WxMaLiveAssistantInfo> users)
              throws WxErrorException
```
    添加管理直播间小助手
    调用接口往指定直播间添加管理直播间小助手调用频率调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/addassistant?access_token=ACCESS_TOKEN
    参数:
    
    roomId - 房间ID
    
    users - 数组列表，可传入多个，"users": [{"username":"testwechat","nickname":"testnick"}]
    
    返回:
    
    添加管理直播间小助手是否成功
    
    抛出:
    
    WxErrorException - .
  - modifyAssistant
```
boolean modifyAssistant(Integer roomId,
                        String username,
                        String nickname)
                 throws WxErrorException
```
    修改直播间小助手昵称
    调用接口修改直播间小助手昵称调用频率调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/modifyassistant?access_token=ACCESS_TOKEN
    参数:
    
    roomId - 房间ID
    
    username - 小助手微信号
    
    nickname - 小助手直播间昵称
    
    返回:
    
    修改小助手昵称是否成功
    
    抛出:
    
    WxErrorException - .
  - removeAssistant
```
boolean removeAssistant(Integer roomId,
                        String username)
                 throws WxErrorException
```
    删除直播间小助手
    删除直播间小助手调用频率调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/removeassistant?access_token=ACCESS_TOKEN
    参数:
    
    roomId - 房间ID
    
    username - 小助手微信号
    
    返回:
    
    删除小助手昵称是否成功
    
    抛出:
    
    WxErrorException - .
  - getAssistantList
```
List<WxMaAssistantResult.Assistant> getAssistantList(Integer roomId)
                                              throws WxErrorException
```
    查询直播间小助手
    查询直播间小助手调用频率调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/getassistantlist?access_token=ACCESS_TOKEN
    参数:
    
    roomId - 房间ID
    
    返回:
    
    小助手列表
    
    抛出:
    
    WxErrorException - .
  - addSubanchor
```
boolean addSubanchor(Integer roomId,
                     String username)
              throws WxErrorException
```
    添加主播副号
    调用接口添加主播副号
    调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/addsubanchor?access_token=ACCESS_TOKEN
    参数:
    
    roomId - 房间ID
    
    username - 用户微信号
    
    返回:
    
    是否成功
    
    抛出:
    
    WxErrorException - .
  - modifySubanchor
```
boolean modifySubanchor(Integer roomId,
                        String username)
                 throws WxErrorException
```
    修改主播副号
    调用接口修改主播副号
    调用频率: 10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/modifyassistant?access_token=ACCESS_TOKEN
    参数:
    
    roomId - 房间ID
    
    username - 小助手微信号
    
    username - 用户微信号
    
    返回:
    
    是否成功
    
    抛出:
    
    WxErrorException - .
  - deleteSubanchor
```
boolean deleteSubanchor(Integer roomId)
                 throws WxErrorException
```
    删除主播副号
    调用频率: 10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/deletesubanchor?access_token=ACCESS_TOKEN
    参数:
    
    roomId - 房间ID
    
    返回:
    
    是否成功
    
    抛出:
    
    WxErrorException - .
  - getSubanchor
```
String getSubanchor(Integer roomId)
             throws WxErrorException
```
    获取主播副号
    调用额度：10000次/一天
    http请求方式：GET https://api.weixin.qq.com/wxaapi/broadcast/room/getsubanchor?access_token=ACCESS_TOKEN
    
    参数:
    
    roomId - 直播间id
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - updatefeedpublic
```
boolean updatefeedpublic(Integer roomId,
                         Integer isFeedsPublic)
                  throws WxErrorException
```
    开启/关闭直播间官方收录
    调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/updatefeedpublic?access_token=ACCESS_TOKEN
    参数:
    
    roomId - 房间ID
    
    isFeedsPublic - 是否开启官方收录【1: 开启，0：关闭】
    
    返回:
    
    是否成功
    
    抛出:
    
    WxErrorException - .
  - updatereplay
```
boolean updatereplay(Integer roomId,
                     Integer closeReplay)
              throws WxErrorException
```
    开启/关闭回放功能
    调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/updatereplay?access_token=ACCESS_TOKEN
    参数:
    
    roomId - 房间ID
    
    closeReplay - 是否关闭回放【0：开启，1：关闭】
    
    返回:
    
    是否成功
    
    抛出:
    
    WxErrorException - .
  - updatekf
```
boolean updatekf(Integer roomId,
                 Integer closeKf)
          throws WxErrorException
```
    开启/关闭客服功能
    调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/updatekf?access_token=ACCESS_TOKEN
    参数:
    
    roomId - 房间ID
    
    closeKf - 是否关闭客服【0：开启，1：关闭】
    
    返回:
    
    是否成功
    
    抛出:
    
    WxErrorException - .
  - updatecomment
```
boolean updatecomment(Integer roomId,
                      Integer banComment)
               throws WxErrorException
```
    开启/关闭直播间全局禁言
    调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/updatecomment?access_token=ACCESS_TOKEN
    参数:
    
    roomId - 房间ID
    
    banComment - 1-禁言，0-取消禁言
    
    返回:
    
    是否成功
    
    抛出:
    
    WxErrorException - .
  - onsale
```
boolean onsale(Integer roomId,
               Integer goodsId,
               Integer onSale)
        throws WxErrorException
```
    上下架商品
    调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/goods/onsale?access_token=ACCESS_TOKEN
    参数:
    
    roomId - 房间ID
    
    goodsId - 商品ID
    
    onSale - 上下架【0：下架，1：上架】
    
    返回:
    
    是否成功
    
    抛出:
    
    WxErrorException - .
  - deleteInRoom
```
boolean deleteInRoom(Integer roomId,
                     Integer goodsId)
              throws WxErrorException
```
    删除直播间商品
    调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/goods/deleteInRoom?access_token=ACCESS_TOKEN
    参数:
    
    roomId - 房间ID
    
    goodsId - 商品ID
    
    返回:
    
    是否成功
    
    抛出:
    
    WxErrorException - .
  - push
```
boolean push(Integer roomId,
             Integer goodsId)
      throws WxErrorException
```
    推送商品
    调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/goods/push?access_token=ACCESS_TOKEN
    参数:
    
    roomId - 房间ID
    
    goodsId - 商品ID
    
    返回:
    
    是否成功
    
    抛出:
    
    WxErrorException - .
  - sort
```
boolean sort(Integer roomId,
             List<Map<String,String>> goods)
      throws WxErrorException
```
    直播间商品排序
    调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/goods/sort?access_token=ACCESS_TOKEN
    参数:
    
    roomId - 房间ID
    
    goods - 商品ID列表, 例如: [{"goodsId":"123"}, {"goodsId":"234"}]
    
    返回:
    
    是否成功
    
    抛出:
    
    WxErrorException - .
  - getVideo
```
String getVideo(Integer roomId,
                Integer goodsId)
         throws WxErrorException
```
    下载商品讲解视频
    调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/goods/getVideo?access_token=ACCESS_TOKEN
    
    参数:
    
    roomId - 直播间id
    
    goodsId - 商品ID
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .

接口 WxMaLiveService

方法概要

方法详细资料

createRoom

deleteRoom

editRoom

getPushUrl

getSharedCode

getLiveInfo

getLiveInfos

getLiveReplay

getLiveReplay

addGoodsToRoom

addAssistant

modifyAssistant

removeAssistant

getAssistantList

addSubanchor

modifySubanchor

deleteSubanchor

getSubanchor

updatefeedpublic

updatereplay

updatekf

updatecomment

onsale

deleteInRoom

push

sort

getVideo