# 获取可设置公众号列表

调试诊断

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

接口英文名:getLinkForShow

通过本接口可以获取扫码关注组件允许展示的公众号列表

# 1. 调用方式

# HTTPS 调用

GET https://api.weixin.qq.com/wxa/getwxamplinkforshow?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:18

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 authorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
pagenumber页码,从 0 开始
numnumber每页记录数,最大为 20

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber返回码
errmsgstring错误信息
total_numnumber总记录数
biz_info_listobjarray公众号信息列表

# Res.biz_info_list(Array) Object Payload

公众号信息列表

参数名类型说明
nicknamestring公众号昵称
appidstring公众号 appid
headimgstring公众号头像

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

GET https://api.weixin.qq.com/wxa/getwxamplinkforshow?page=0&num=20&access_token=ACCESS_TOKEN

返回示例

{
  "errcode": 0,
  "errmsg": "ok",
  "total_num": 10,
  "biz_info_list": [
    {
      "nickname": "公众号昵称",
      "appid": "公众号appid",
      "headimg": "公众号头像"
    }
  ]
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

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

# 7. 适用范围

本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。