小程序直播 /长期订阅 /获取长期订阅用户

# 获取长期订阅用户

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

## 接口说明

### 接口英文名

getFollowers

### 功能描述

该接口用于获取长期订阅用户列表。

## 调用方式

### HTTPS 调用

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

### 云调用

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

### 第三方调用

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

### 请求参数含义

| **参数**   | **类型** | **必填** | **说明**                                                     |
| :--------- | :------- | :------- | :----------------------------------------------------------- |
| limit      | Number   | 否       | 获取长期订阅用户的个数限制,默认200,最大2000                |
| page_break | Number   | 否       | 翻页标记,获取第一页时不带,第二页开始需带上上一页返回结果中的page_break |

### 返回参数含义

| **参数**       | **说明**                         |
| :------------- | :------------------------------- |
| followers      | 长期订阅用户列表                 |
| openid         | 长期订阅用户OpenId               |
| subscribe_time | 长期订阅用户订阅时间             |
| room_id        | 用户订阅时所处房间               |
| room_status    | 用户订阅时房间状态               |
| page_break     | 翻页标记,获取下一页时带上该值   |
| errcode        | 接口返回码,0表示成功,非0则失败 |
| errmsg         | 接口返回提示信息                 |

## 调用示例

> 示例说明: HTTPS请求示例

### 请求数据示例

```json
{    
    "limit": 200,
    "page_break":0 
} 
```

### 返回数据示例

```json
{
    "errcode": 0,
    "errmsg": "ok"
} 
```

### 错误码

| 错误码 | 错误码取值                                              | 解决方案                                                     |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| 40001  | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |