# 获取公众号关联的小程序
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getLinkMiniprogram
该接口用于获取公众号关联的小程序
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cgi-bin/wxopen/wxamplinkget?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:33
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 authorizer_access_token |
# 请求体 Request Payload
无
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 返回码 |
| errmsg | string | 错误信息 |
| wxopens | object | 关联的小程序列表 |
# Res.wxopens Object Payload
关联的小程序列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| items | objarray | 关联的小程序信息 |
# Res.wxopens.items(Array) Object Payload
关联的小程序信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| nickname | string | 小程序名称 |
| headimg_url | string | 头像 url |
| status | number | 关联状态。1表示已关联;2表示等待小程序管理员确认中;3表示小程序管理员拒绝关联;12表示等待公众号管理员确认中; |
| appid | string | 小程序 appid |
| func_infos | objarray | 微信认证及支付信息。 |
| selected | number | 是否在公众号管理页展示中。1表示是,0表示否。 |
| username | string | 小程序原始id |
| string | 小程序邮箱 | |
| nearby_display_status | number | 是否展示在附近的小程序中。1表示是,0表示否。 |
| released | number | 是否已经发布。1表示是,0表示否 |
# Res.wxopens.items(Array).func_infosObject Payload
Object Payload微信认证及支付信息。
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | number | "微信认证"或者"微信支付"的id |
| status | number | 开通状态。0 表示未开通,1 表示开通 |
| name | string | "微信认证"或者"微信支付" |
# 4. 注意事项
公众号需要先把“小程序关联管理”权限集授权给第三方平台,第三方平台才可以调用此接口进行关联和管理操作。
# 5. 代码示例
请求示例
POST https://api.weixin.qq.com/cgi-bin/wxopen/wxamplinkget?access_token=TOKEN
返回示例
{
"errcode" : 0,
"errmsg" : "ok",
"wxopens" : {
"items" : [
{
"status" : 1,
"username" : "gh_xxxxxxxxx",
"appid" : "xxxxx",
"source" : "SOURCE_NORMAL",
"nickname" : "aaaaaaa",
"selected" : 1,
"nearby_display_status" : 0,
"released" : 1,
"headimg_url" : "http://xxx.png",
"func_infos" : [
{
"status" : 0,
"id" : 1,
"name" : "微信认证"
},
{
"status" : 0,
"id" : 2,
"name" : "微信支付"
}
],
"copy_verify_status" : 1,
"email" : "xxxx@qq.com"
},
{
"status" : 3,
"username" : "gh_xxxxxxxxxx",
"source" : "SOURCE_NORMAL",
"headimg_url" : "http://yyy.png",
"func_infos" : []
"nickname" : "bbbbbbb"
},
]
}
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| -1 | system error | 系统繁忙,此时请开发者稍候再试 |
| 0 | ok | ok |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
| 89007 | 小程序本月被关联的名额已用完 | 小程序本月被关联的名额已用完 |
| 89008 | overseas account can not link | 小程序为海外帐号,不允许关联 |
| 89009 | 小程序关联达到上限 | 小程序关联达到上限 |
| 89010 | link message has sent | 已经发送关联邀请 |
| 89011 | 在附近中展示的小程序不能取消关联 | 在附近中展示的小程序不能取消关联 |
| 89012 | can not unlink store or mall | 门店、小店小程序不能取消关联 |
| 89013 | 小程序被封禁 | 小程序被封禁 |
| 89014 | support version error | 基础库版本输入错误 |
| 89015 | has linked wxa | 已经关联该小程序 |
| 89016 | 公众号本月关联相同主体达到上限 | 公众号本月关联相同主体达到上限 |
| 89017 | reach different realname quota | 公众号本月关联不同主体达到上限 |
| 89035 | linking from mp | 已经从公众平台后台发起关联申请,处于小程序管理员确认中,无法从第三方重复发起关联申请 |
# 7. 适用范围
本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。