nearbyPoi.getList

本接口应在服务器端调用,详细说明参见服务端API

本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载),wx-server-sdk >= 0.4.0

查看地点列表

调用方式:

HTTPS 调用

请求地址

  1. GET https://api.weixin.qq.com/wxa/getnearbypoilist?page=1&page_rows=20&access_token=ACCESS_TOKEN

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证
pagenumber起始页id(从1开始计数)
page_rowsnumber每页展示个数(最多1000个)

返回值

Object

属性类型说明
errmsgstring错误信息
errcodenumber错误码
dataobject返回数据

data 的结构

属性类型说明
left_apply_numnumber剩余可添加地点个数
max_apply_numnumber最大可添加地点个数
datastring地址列表的 JSON 格式字符串

data.data 的结构

属性类型说明
poi_listArray.<Object>地址列表

data.data.poi_list 的结构

属性类型说明
poi_idstring附近地点 ID
qualification_addressstring资质证件地址
qualification_numstring资质证件证件号
audit_statusnumber地点审核状态
display_statusnumber地点展示在附近状态
refuse_reasonstring审核失败原因,audit_status=4 时返回

audit_status 的合法值

说明最低版本
3审核中
4审核失败
5审核通过

display_status 的合法值

说明最低版本
0未展示
1展示中

错误

错误码错误信息说明
0ok正常
47001POST数据json格式错误
20002POST参数非法
44002POST数据为空
92000该经营资质已添加,请勿重复添加
92002附近地点添加数量达到上线,无法继续添加
92003地点已被其它小程序占用
92004附近功能被封禁
92005地点正在审核中
92006地点正在展示小程序
92007地点审核失败
92008程序未展示在该地点
93009小程序未上架或不可见
93010地点不存在
93011个人类型小程序不可用
93011个人类型小程序不可用
93012非普通类型小程序(门店小程序、小店小程序等)不可用
93013从腾讯地图获取地址详细信息失败
93014同一资质证件号重复添加

返回数据示例

  1. {
  2. "errcode": 0,
  3. "errmsg": "",
  4. "data": {
  5. "left_apply_num": 9,
  6. "max_apply_num": 10,
  7. "data": "{\"poi_list\": [{\"poi_id\": \"123456\",\"qualification_address\": \"广东省广州市海珠区新港中路123号\",\"qualification_num\": \"123456789-1\",\"audit_status\": 3,\"display_status\": 0,\"refuse_reason\": \"\"}]}"
  8. }
  9. }

云调用

云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。

接口方法

  1. openapi.nearbyPoi.getList

需在 config.json 中配置 nearbyPoi.getList API 的权限,详情

请求参数

属性类型默认值必填说明
pagenumber起始页id(从1开始计数)
pageRowsnumber每页展示个数(最多1000个)

返回值

Object

属性类型说明
errMsgstring错误信息
errCodenumber错误码
dataobject返回数据

data 的结构

属性类型说明
leftApplyNumnumber剩余可添加地点个数
maxApplyNumnumber最大可添加地点个数
datastring地址列表的 JSON 格式字符串

data.data 的结构

属性类型说明
poiListArray.<Object>地址列表

data.data.poiList 的结构

属性类型说明
poiIdstring附近地点 ID
qualificationAddressstring资质证件地址
qualificationNumstring资质证件证件号
auditStatusnumber地点审核状态
displayStatusnumber地点展示在附近状态
refuseReasonstring审核失败原因,audit_status=4 时返回

auditStatus 的合法值

说明最低版本
3审核中
4审核失败
5审核通过

displayStatus 的合法值

说明最低版本
0未展示
1展示中

异常

Object

抛出的异常

属性类型说明
errMsgstring错误信息
errCodenumber错误码

errCode 的合法值

说明最低版本

错误

错误码错误信息说明
0ok正常
47001POST数据json格式错误
20002POST参数非法
44002POST数据为空
92000该经营资质已添加,请勿重复添加
92002附近地点添加数量达到上线,无法继续添加
92003地点已被其它小程序占用
92004附近功能被封禁
92005地点正在审核中
92006地点正在展示小程序
92007地点审核失败
92008程序未展示在该地点
93009小程序未上架或不可见
93010地点不存在
93011个人类型小程序不可用
93011个人类型小程序不可用
93012非普通类型小程序(门店小程序、小店小程序等)不可用
93013从腾讯地图获取地址详细信息失败
93014同一资质证件号重复添加

请求示例

  1. const cloud = require('wx-server-sdk')
  2. cloud.init()
  3. exports.main = async (event, context) => {
  4. try {
  5. const result = await cloud.openapi.nearbyPoi.getList({
  6. page: '',
  7. pageRows: ''
  8. })
  9. console.log(result)
  10. return result
  11. } catch (err) {
  12. console.log(err)
  13. return err
  14. }
  15. }

返回数据示例

  1. {
  2. "errCode": 0,
  3. "errMsg": "openapi.nearbyPoi.getList:ok",
  4. "data": {
  5. "data": "{\"poi_list\": [{\"poi_id\": \"123456\",\"qualification_address\": \"广东省广州市海珠区新港中路123号\",\"qualification_num\": \"123456789-1\",\"audit_status\": 3,\"display_status\": 0,\"refuse_reason\": \"\"}]}",
  6. "leftApplyNum": 9,
  7. "maxApplyNum": 10
  8. }
  9. }