# 查看地点
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getNearbyPoiList
该接口用于查看附近小程序的地点列表。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/getnearbypoilist?access_token=ACCESS_TOKEN
# 云调用
调用方法:nearbyPoi.getList
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:37
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| page | number | 是 | 起始页id(从1开始计数) |
| page_rows | number | 是 | 每页展示个数(最多1000个) |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| data | object | 附近小程序的数据 |
# Res.data Object Payload
附近小程序的数据
| 参数名 | 类型 | 说明 |
|---|---|---|
| max_apply_num | number | 最大可添加地点个数 |
| left_apply_num | number | 剩余可添加地点个数 |
| data | string | 地址列表的 JSON 格式字符串 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"page": 1,
"page_rows": 100
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"data": {
"left_apply_num": 9,
"max_apply_num": 10,
"data": "{\"poi_list\": [{\"poi_id\": \"123456\",\"qualification_address\": \"广东省广州市海珠区新港中路123号\",\"qualification_num\": \"123456789-1\",\"audit_status\": 3,\"display_status\": 0,\"refuse_reason\": \"\"}]}"
}
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 20002 | POST参数非法 | |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
| 44002 | empty post data | POST 的数据包为空 |
| 92000 | 该经营资质已添加,请勿重复添加 | 该经营资质已添加,请勿重复添加 |
| 92002 | 附近地点添加数量达到上线,无法继续添加 | 附近地点添加数量达到上线,无法继续添加 |
| 92003 | 地点已被其它小程序占用 | 地点已被其它小程序占用 |
| 92004 | 附近功能被封禁 | |
| 92005 | 地点正在审核中 | 地点正在审核中 |
| 92006 | 地点正在展示小程序 | |
| 92007 | 地点审核失败 | |
| 92008 | 小程序未展示在该地点 | 小程序未展示在该地点 |
| 93009 | 小程序未上架或不可见 | 小程序未上架或不可见 |
| 93010 | 地点不存在 | 地点不存在 |
| 93011 | 个人类型小程序不可用 | 个人类型小程序不可用 |
| 93012 | 非普通类型小程序(门店小程序、小店小程序等)不可用 | 非普通类型小程序(门店小程序、小店小程序等)不可用 |
| 93013 | 从腾讯地图获取地址详细信息失败 | 从腾讯地图获取地址详细信息失败 |
| 93014 | 同一资质证件号重复添加 |
# 7. 适用范围
本接口支持「小程序」账号类型调用。其他账号类型如无特殊说明,均不可调用。