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

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:listbusiness

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

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 本接口不支持云调用。

# 第三方调用

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

# 2. 请求参数

# 查询参数 Query String Parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_token

# 请求体 Request Payload

参数名类型必填说明
offsetnumber用于分页拉取,从0开始
countnumber一次拉取的商户个数,最多为200

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误描述
listobjarray商户信息列表

# Res.list(Array) Object Payload

商户信息列表

参数名类型说明
business_idstring商户ID
account_namestring商户账号名称
nicknamestring商户昵称,会在客户端会话里展示
icon_media_idstring商户头像

# 4. 注意事项

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

# 5. 代码示例

请求示例

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

返回示例

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

# 6. 错误码

此接口没有特殊错误码,可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

# 7. 适用范围

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