# 查看地点
接口应在服务器端调用,详细说明参见服务端API。
本接口支持云调用。需开发者工具版本 >=
1.02.1904090
(最新稳定版下载),wx-server-sdk
>=0.4.0
# 接口说明
# 接口英文名
getNearbyPoiList
# 功能描述
该接口用于查看附近小程序的地点列表。
# 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/getnearbypoilist?access_token=ACCESS_TOKEN
# 云调用
出入参和HTTPS调用相同,调用方式可查看云调用说明文档
接口方法为: openapi.nearbyPoi.getList
# 第三方调用
调用方式以及出入参和HTTPS相同,仅是调用的token不同
该接口所属的权限集id为:37
服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用
# 请求参数
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用access_token或者authorizer_access_token |
page | number | 是 | 起始页id(从1开始计数) |
page_rows | number | 是 | 每页展示个数(最多1000个) |
# 返回参数
属性 | 类型 | 说明 | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errcode | number | 错误码 | |||||||||||||||||
errmsg | string | 错误信息 | |||||||||||||||||
data | object | 附近小程序的数据 | |||||||||||||||||
|
# 其他说明
# 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 | 未展示 |
1 | 展示中 |
# 调用示例
示例说明: HTTPS调用
# 请求数据示例
{
"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\": \"\"}]}"
}
}
# 错误码
错误码 | 错误码取值 | 解决方案 |
---|---|---|
40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
20002 | POST参数非法 | |
44002 | empty post data | POST 的数据包为空 |
92000 | 该经营资质已添加,请勿重复添加 | 该经营资质已添加,请勿重复添加 |
92002 | 附近地点添加数量达到上线,无法继续添加 | 附近地点添加数量达到上线,无法继续添加 |
92003 | 地点已被其它小程序占用 | 地点已被其它小程序占用 |
92004 | 附近功能被封禁 | |
92005 | 地点正在审核中 | 地点正在审核中 |
92006 | 地点正在展示小程序 | |
92007 | 地点审核失败 | |
92008 | 小程序未展示在该地点 | 小程序未展示在该地点 |
93009 | 小程序未上架或不可见 | 小程序未上架或不可见 |
93010 | 地点不存在 | 地点不存在 |
93011 | 个人类型小程序不可用 | 个人类型小程序不可用 |
93012 | 非普通类型小程序(门店小程序、小店小程序等)不可用 | 非普通类型小程序(门店小程序、小店小程序等)不可用 |
93013 | 从腾讯地图获取地址详细信息失败 | 从腾讯地图获取地址详细信息失败 |
93014 | 同一资质证件号重复添加 |