微信小程序 getList

2022-05-11 14:59 更新

nearbyPoi.getList

本接口應在服務器端調用,詳細說明參見服務端API
本接口支持云調用。需開發(fā)者工具版本 >= 1.02.1904090(最新穩(wěn)定版下載
wx-server-sdk >= 0.4.0

查看地點列表

調用方式:

  • HTTPS 調用
  • 云調用

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 地點審核狀態(tài)
display_status number 地點展示在附近狀態(tài)
refuse_reason string 審核失敗原因,audit_status=4 時返回

audit_status 的合法值

說明 最低版本
3 審核中
4 審核失敗
5 審核通過

display_status 的合法值

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

錯誤

錯誤碼 錯誤信息 說明
0 ok 正常
47001 POST數據json格式錯誤
20002 POST參數非法
44002 POST數據為空
92000 該經營資質已添加,請勿重復添加
92002 附近地點添加數量達到上線,無法繼續(xù)添加
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\": \"廣東省廣州市海珠區(qū)新港中路123號\",\"qualification_num\": \"123456789-1\",\"audit_status\": 3,\"display_status\": 0,\"refuse_reason\": \"\"}]}"
   }
}

云調用

云調用是小程序·云開發(fā)提供的在云函數中調用微信開放接口的能力,需要在云函數中通過 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 地點審核狀態(tài)
displayStatus number 地點展示在附近狀態(tài)
refuseReason string 審核失敗原因,audit_status=4 時返回

auditStatus 的合法值

說明 最低版本
3 審核中
4 審核失敗
5 審核通過

displayStatus 的合法值

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

異常

Object

拋出的異常

屬性 類型 說明
errMsg string 錯誤信息
errCode number 錯誤碼

errCode 的合法值

說明 最低版本

錯誤

錯誤碼 錯誤信息 說明
0 ok 正常
47001 POST數據json格式錯誤
20002 POST參數非法
44002 POST數據為空
92000 該經營資質已添加,請勿重復添加
92002 附近地點添加數量達到上線,無法繼續(xù)添加
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\": \"廣東省廣州市海珠區(qū)新港中路123號\",\"qualification_num\": \"123456789-1\",\"audit_status\": 3,\"display_status\": 0,\"refuse_reason\": \"\"}]}",
    "leftApplyNum": 9,
    "maxApplyNum": 10
  }
}


以上內容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號