getLiveInfo.md

小程序直播 /直播间管理 /获取直播间列表和回放

# 获取直播间列表和回放

> 接口应在服务器端调用，详细说明参见[服务端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`

## 接口说明

### 接口英文名

getLiveInfo

### 功能描述

该接口用于获取直播间列表及直播间信息。也可以用来获取已结束直播间的回放源视频（一般在直播结束后10分钟内生成，源视频无评论等内容）。

### 注意事项

调用额度：100000次/一天

## 调用方式

### HTTPS 调用

```text
POST https://api.weixin.qq.com/wxa/business/getliveinfo?access_token=ACCESS_TOKEN 
```

### 云调用

- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.liveBroadcast.getLiveInfo

### 第三方调用

- 调用方式以及出入参和 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)代商家进行调用

### 请求参数

| 属性                                  | 类型   | 必填 | 说明                                                         |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是   | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| start                                 | number | 是   | 起始拉取视频，0表示从第一个视频片段开始拉取                  |
| limit                                 | number | 是   | 每次拉取的数量，建议100以内                                  |
| action                                | string | 否   | 只能填"get_replay"，表示获取回放。                           |
| room_id                               | number | 否   | 当 action 有值时该字段必填，直播间ID                         |

### 返回参数

|      | 属性                                                         | 类型          | 说明                        |
| :--- | :----------------------------------------------------------- | :------------ | :-------------------------- |
|      | errcode                                                      | number        | 错误码                      |
|      | errmsg                                                       | string        | 错误信息                    |
|      | room_info                                                    | array<object> | action="get_replay"不返回。 |
|      | 属性类型说明namestring直播间名称cover_imgstring直播间背景图链接start_timenumber直播间开始时间，列表按照start_time降序排列end_timenumber直播计划结束时间anchor_namestring主播名roomidnumber直播间IDgoodsarray<object>商品属性类型说明namestring商品名称cover_imgstring商品封面图链接urlstring商品小程序路径pricenumber商品价格（分）price2number商品价格，使用方式看price_typeprice_typenumber价格类型，1：一口价（只需要传入price，price2不传） 2：价格区间（price字段为左边界，price2字段为右边界，price和price2必传） 3：显示折扣价（price字段为原价，price2字段为现价， price和price2必传）goods_idnumber商品idthird_party_appidstring第三方商品appid ,当前小程序商品则为空live_statusnumber直播间状态。101：直播中，102：未开始，103已结束，104禁播，105：暂停，106：异常，107：已过期share_imgstring直播间分享图链接live_typenumber直播类型，1 推流 0 手机直播close_likenumber是否关闭点赞 【0：开启，1：关闭】（若关闭，观众端将隐藏点赞按钮，直播开始后不允许开启）close_goodsnumber是否关闭货架 【0：开启，1：关闭】（若关闭，观众端将隐藏商品货架，直播开始后不允许开启）close_commentnumber是否关闭评论 【0：开启，1：关闭】（若关闭，观众端将隐藏评论入口，直播开始后不允许开启）close_kfnumber是否关闭客服 【0：开启，1：关闭】 默认关闭客服（直播开始后允许开启）close_replaynumber是否关闭回放 【0：开启，1：关闭】默认关闭回放（直播开始后允许开启）is_feeds_publicnumber是否开启官方收录，1 开启，0 关闭creater_openidstring创建者openidfeeds_imgstring官方收录封面 |               |                             |
|      | total                                                        | number        | 拉取房间总数                |
|      | live_replay                                                  | array<object> | action="get_replay"才返回。 |
|      | 属性类型说明create_timestring回放视频创建时间expire_timestring回放视频 url 过期时间media_urlstring回放视频链接 |               |                             |

## 调用示例

> 示例说明: HTTPS请求示例

### 请求数据示例

```json
{
    "start": 0, // 起始拉取房间，start = 0 表示从第 1 个房间开始拉取
    "limit": 10 // 每次拉取的个数上限，不要设置过大，建议 100 以内
} 
```

### 返回数据示例

```json
{
    "errcode": 0,    // 错误码，0代表成功，1代表未创建直播间
    "errmsg": "ok",   // 错误信息
    "total":1,
    "room_info":[{
        "name":"直播房间名"
        "roomid": 1,
        "cover_img":"http://http:\/\/mmbiz.qpic.cn\/mmbiz_jpg\Rl1RuuhdstSfZa8EEljedAYcbtX3Ejpdl2et1tPAQ37bdicnxoVialDLCKKDcPBy8Iic0kCiaiaalXg3EbpNKoicrweQ\/0?wx_fmt=jpeg",
        "share_img":"http://http:\/\/mmbiz.qpic.cn\/mmbiz_jpg\Rl1RuuhdstSfZa8EEljedAYcbtX3Ejpdl2et1tPAQ37bdicnxoVialDLCKKDcPBy8Iic0kCiaiaalXg3EbpNKoicrweQ\/0?wx_fmt=jpeg",
        "live_status": 101,
        "start_time": 1568128900,
        "end_time": 1568131200,
        "anchor_name":"里斯",
        "goods":[{
            "cover_img":"http://http:\/\/mmbiz.qpic.cn\/mmbiz_jpg\/Rl1RuuhdstSfZa8EEljedAYcbtX3Ejpdl2et1tPAQ37bdicnxoVialDLCKKDcPBy8Iic0kCiaiaalXg3EbpNKoicrweQ\/0?wx_fmt=jpeg",
            "url":"pages/index/index.html",
            "name":"茶杯",
            "price": 1889,          // 价格（分）
            "price2": 0,
            "price_type": 1,        // 价格类型，1：一口价（只需要传入price，price2不传） 2：价格区间（price字段为左边界，price2字段为右边界，price和price2必传） 3：显示折扣价（price字段为原价，price2字段为现价， price和price2必传）
            "goods_id": 256,        // 商品id
            "third_party_appid": "wx3d0fae56402d8a81" //第三方商品appid ,当前小程序商品则为空
        }],
        "live_type": 0,				// 直播类型，1 推流 0 手机直播
        "close_like": 0,			// 是否关闭点赞 【0：开启，1：关闭】（若关闭，观众端将隐藏点赞按钮，直播开始后不允许开启）
        "close_goods": 0,			// 是否关闭货架 【0：开启，1：关闭】（若关闭，观众端将隐藏商品货架，直播开始后不允许开启）
        "close_comment": 0,			// 是否关闭评论 【0：开启，1：关闭】（若关闭，观众端将隐藏评论入口，直播开始后不允许开启）
        "close_kf": 1,				// 是否关闭客服 【0：开启，1：关闭】 默认关闭客服（直播开始后允许开启）
        "close_replay": 1,			// 是否关闭回放 【0：开启，1：关闭】默认关闭回放（直播开始后允许开启）
        "is_feeds_public": 0,		// 是否开启官方收录，1 开启，0 关闭
        "creater_openid": "oawjt4t9NWZV2BYaEPA89sh1XblE", // 创建者openid
        "feeds_img": "XXX"			// 官方收录封面
    }]
} 
```

### 错误码

| 错误码 | 错误码取值                                              | 解决方案                                                     |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1     | system error                                            | 系统繁忙，此时请开发者稍候再试                               |
| 40001  | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |