# 客服子商户拉取多个商户信息

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：listbusiness

本接口用于拉取多个「客服子商户」的信息。

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/cgi-bin/business/list?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口不支持第三方平台调用。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "offset",
    "类型": "number",
    "必填": "是",
    "说明": "用于分页拉取，从0开始"
  },
  {
    "参数名": "count",
    "类型": "number",
    "必填": "是",
    "说明": "一次拉取的商户个数，最多为200"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误描述"
  },
  {
    "参数名": "list",
    "类型": "objarray",
    "说明": "商户信息列表"
  }
]
```

">

### Res.list(Array) `Object Payload`

商户信息列表

```json
[
  {
    "参数名": "business_id",
    "类型": "string",
    "说明": "商户ID"
  },
  {
    "参数名": "account_name",
    "类型": "string",
    "说明": "商户账号名称"
  },
  {
    "参数名": "nickname",
    "类型": "string",
    "说明": "商户昵称，会在客户端会话里展示"
  },
  {
    "参数名": "icon_media_id",
    "类型": "string",
    "说明": "商户头像"
  }
]
```

## 4. 注意事项

某一次请求的返回的数据量小于count数，说明请求的数据已经到了末端

## 5. 代码示例

请求示例

```json
{
    "offset": 0,
    "count": 100
}
```

返回示例

```json
{
    "list": [
        {
            "business_id": 1,
            "account_name": "apple",
            "nickname":"苹果",
            "icon_url":"icon_url"
        },
        {
            "business_id": 2,
            "account_name": "apple",
            "nickname":"苹果",
            "icon_url":"icon_url"
        }
    ]
}
```

## 6. 错误码

此接口没有特殊错误码，可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

## 7. 适用范围

本接口暂未明确可调用账号类型，或在业务中根据调用传参自行确定是否可调用，请以实际调用情况为准。
