# nearbyPoi.getList

Call this API at the server side. For more information, see Server API.

This API supports Cloud Calls. The WeChat DevTools version must be 1.02.1904090 or later (download the latest stable version here), and the wx-server-sdk version must be 0.4.0 or later.

Views the location list.

Calling methods:

• HTTPS call
• Cloud call

# HTTPS Call

# Request Address

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

# Request Parameters

# Return Value

# Object

data is composed as follows

data.data is composed as follows

data.data.poi_list is composed as follows

Valid values of audit_status

Valid values of display_status

# Errors

# Return Data Example

{
   "errcode": 0,
   "errmsg": "",
   "data": {
      "left_apply_num": 9,
      "max_apply_num": 10,
      "data": "{\"poi_list\": [{\"poi_id\": \"123456\",\"qualification_address\": \"No. 123, Xingang Middle Road, Haizhu District, Guangzhou, Guangdong Province\",\"qualification_num\": \"123456789-1\",\"audit_status\": 3,\"display_status\": 0,\"refuse_reason\": \"\"}]}"
   }
}

# Cloud Call

Cloud call is a capability provided by Mini Program·Cloud Base that allows you to call WeChat APIs in a cloud function. It must be used via wx-server-sdk in the cloud function.

# API Calling Method

openapi.nearbyPoi.getList

You need to configure the permissions for the nearbyPoi.getList API via config.json. Details

# Request Parameters

# Return Value

# Object

data is composed as follows

data.data is composed as follows

data.data.poiList is composed as follows

Valid values of auditStatus

Valid values of displayStatus

# Exceptions

# Object

Thrown Exceptions

Valid values of errCode

# Errors

# Request Example

const cloud = require('wx-server-sdk')
  cloud.init()
  exports.main = async (event, context) => {
    try {
      const result = await cloud.openapi.nearbyPoi.getList({
        page: '',
        pageRows: ''
      })
      console.log(result)
      return result
    } catch (err) {
      console.log(err)
      return err
    }
  }

# Return Data Example

{
  "errCode": 0,
  "errMsg": "openapi.nearbyPoi.getList:ok",
  "data": {
    "data": "{\"poi_list\": [{\"poi_id\": \"123456\",\"qualification_address\": \"No. 123, Xingang Middle Road, Haizhu District, Guangzhou, Guangdong Province\",\"qualification_num\": \"123456789-1\",\"audit_status\": 3,\"display_status\": 0,\"refuse_reason\": \"\"}]}",
    "leftApplyNum": 9,
    "maxApplyNum": 10
  }
}