微信小程序 getList
nearbyPoi.getList
本接口应在服务器端调用，详细说明参见服务端API。
本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载）
wx-server-sdk >= 0.4.0
查看地点列表
调用方式：
HTTPS 调用
请求地址
GET https://api.weixin.qq.com/wxa/getnearbypoilist?page=1&page_rows=20&access_token=ACCESS_TOKEN
请求参数
| 属性 |
类型 |
默认值 |
必填 |
说明 |
| access_token |
string |
|
是 |
接口调用凭证 |
| page |
number |
|
是 |
起始页id（从1开始计数） |
| page_rows |
number |
|
是 |
每页展示个数（最多1000个） |
返回值
Object
| 属性 |
类型 |
说明 |
| errmsg |
string |
错误信息 |
| errcode |
number |
错误码 |
| data |
object |
返回数据 |
data 的结构
| 属性 |
类型 |
说明 |
| left_apply_num |
number |
剩余可添加地点个数 |
| max_apply_num |
number |
最大可添加地点个数 |
| data |
string |
地址列表的 JSON 格式字符串
|
data.data 的结构
| 属性 |
类型 |
说明 |
| poi_list |
Array.<Object> |
地址列表 |
data.data.poi_list 的结构
| 属性 |
类型 |
说明 |
| poi_id |
string |
附近地点 ID |
| qualification_address |
string |
资质证件地址 |
| qualification_num |
string |
资质证件证件号 |
| audit_status |
number |
地点审核状态 |
| display_status |
number |
地点展示在附近状态 |
| refuse_reason |
string |
审核失败原因，audit_status=4 时返回 |
audit_status 的合法值
| 值 |
说明 |
最低版本 |
| 3 |
审核中 |
|
| 4 |
审核失败 |
|
| 5 |
审核通过 |
|
display_status 的合法值
错误
| 错误码 |
错误信息 |
说明 |
| 0 |
ok |
正常 |
| 47001 |
|
POST数据json格式错误 |
| 20002 |
|
POST参数非法 |
| 44002 |
|
POST数据为空 |
| 92000 |
|
该经营资质已添加，请勿重复添加 |
| 92002 |
|
附近地点添加数量达到上线，无法继续添加 |
| 92003 |
|
地点已被其它小程序占用 |
| 92004 |
|
附近功能被封禁 |
| 92005 |
|
地点正在审核中 |
| 92006 |
|
地点正在展示小程序 |
| 92007 |
|
地点审核失败 |
| 92008 |
|
程序未展示在该地点 |
| 93009 |
|
小程序未上架或不可见 |
| 93010 |
|
地点不存在 |
| 93011 |
|
个人类型小程序不可用 |
| 93011 |
|
个人类型小程序不可用 |
| 93012 |
|
非普通类型小程序（门店小程序、小店小程序等）不可用 |
| 93013 |
|
从腾讯地图获取地址详细信息失败 |
| 93014 |
|
同一资质证件号重复添加 |
返回数据示例
{
"errcode": 0,
"errmsg": "",
"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\": \"\"}]}"
}
}
云调用
云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。
接口方法
openapi.nearbyPoi.getList
需在 config.json 中配置 nearbyPoi.getList API 的权限，详情
请求参数
| 属性 |
类型 |
默认值 |
必填 |
说明 |
| page |
number |
|
是 |
起始页id（从1开始计数） |
| pageRows |
number |
|
是 |
每页展示个数（最多1000个） |
返回值
Object
| 属性 |
类型 |
说明 |
| errMsg |
string |
错误信息 |
| errCode |
number |
错误码 |
| data |
object |
返回数据 |
data 的结构
| 属性 |
类型 |
说明 |
| leftApplyNum |
number |
剩余可添加地点个数 |
| maxApplyNum |
number |
最大可添加地点个数 |
| data |
string |
地址列表的 JSON 格式字符串
|
data.data 的结构
| 属性 |
类型 |
说明 |
| poiList |
Array.<Object> |
地址列表 |
data.data.poiList 的结构
| 属性 |
类型 |
说明 |
| poiId |
string |
附近地点 ID |
| qualificationAddress |
string |
资质证件地址 |
| qualificationNum |
string |
资质证件证件号 |
| auditStatus |
number |
地点审核状态 |
| displayStatus |
number |
地点展示在附近状态 |
| refuseReason |
string |
审核失败原因，audit_status=4 时返回 |
auditStatus 的合法值
| 值 |
说明 |
最低版本 |
| 3 |
审核中 |
|
| 4 |
审核失败 |
|
| 5 |
审核通过 |
|
displayStatus 的合法值
异常
Object
抛出的异常
| 属性 |
类型 |
说明 |
| errMsg |
string |
错误信息 |
| errCode |
number |
错误码 |
errCode 的合法值
错误
| 错误码 |
错误信息 |
说明 |
| 0 |
ok |
正常 |
| 47001 |
|
POST数据json格式错误 |
| 20002 |
|
POST参数非法 |
| 44002 |
|
POST数据为空 |
| 92000 |
|
该经营资质已添加，请勿重复添加 |
| 92002 |
|
附近地点添加数量达到上线，无法继续添加 |
| 92003 |
|
地点已被其它小程序占用 |
| 92004 |
|
附近功能被封禁 |
| 92005 |
|
地点正在审核中 |
| 92006 |
|
地点正在展示小程序 |
| 92007 |
|
地点审核失败 |
| 92008 |
|
程序未展示在该地点 |
| 93009 |
|
小程序未上架或不可见 |
| 93010 |
|
地点不存在 |
| 93011 |
|
个人类型小程序不可用 |
| 93011 |
|
个人类型小程序不可用 |
| 93012 |
|
非普通类型小程序（门店小程序、小店小程序等）不可用 |
| 93013 |
|
从腾讯地图获取地址详细信息失败 |
| 93014 |
|
同一资质证件号重复添加 |
请求示例
const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.nearbyPoi.getList({
page: '',
pageRows: ''
})
return result
} catch (err) {
return err
}
}
返回数据示例
{
"errCode": 0,
"errMsg": "openapi.nearbyPoi.getList:ok",
"data": {
"data": "{\"poi_list\": [{\"poi_id\": \"123456\",\"qualification_address\": \"广东省广州市海珠区新港中路123号\",\"qualification_num\": \"123456789-1\",\"audit_status\": 3,\"display_status\": 0,\"refuse_reason\": \"\"}]}",
"leftApplyNum": 9,
"maxApplyNum": 10
}
}