# 获取地理位置接口列表

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：getPrivacyInterface

- 该接口用于获取“需申请并审核通过”后才可使用的接口列表。从2022年4月18日开始，部分小程序前端api需申请后，方可使用。
- 使用过程中如遇到问题，可在[开放平台服务商专区](https://developers.weixin.qq.com/community/minihome/mixflow/1355698687267438595)发帖交流。

## 1. 调用方式

### HTTPS 调用

```bash
GET https://api.weixin.qq.com/wxa/security/get_privacy_interface?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：18

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken)"
  }
]
```

### 请求体 `Request Payload`

无

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "interface_list",
    "类型": "objarray",
    "说明": "地理位置相关隐私接口"
  }
]
```

">

### Res.interface_list(Array) `Object Payload`

地理位置相关隐私接口

```json
[
  {
    "参数名": "api_name",
    "类型": "string",
    "说明": "api 英文名"
  },
  {
    "参数名": "api_ch_name",
    "类型": "string",
    "说明": "api 中文名"
  },
  {
    "参数名": "api_desc",
    "类型": "string",
    "说明": "api描述"
  },
  {
    "参数名": "apply_time",
    "类型": "number",
    "说明": "申请时间 ，该字段发起申请后才会有"
  },
  {
    "参数名": "status",
    "类型": "number",
    "说明": "接口状态，该字段发起申请后才会有"
  },
  {
    "参数名": "audit_id",
    "类型": "number",
    "说明": "申请单号，该字段发起申请后才会有"
  },
  {
    "参数名": "fail_reason",
    "类型": "string",
    "说明": "申请被驳回原因或者无权限，该字段申请驳回时才会有"
  },
  {
    "参数名": "api_link",
    "类型": "string",
    "说明": "api文档链接"
  },
  {
    "参数名": "group_name",
    "类型": "string",
    "说明": "分组名"
  }
]
```

## 4. 注意事项

# 其他说明 

### status状态说明

| 状态码 | 说明       |
| ------ | ---------- |
| 1      | 待申请开通 |
| 2      | 无权限     |
| 3      | 申请中     |
| 4      | 申请失败   |
| 5      | 已开通     |

## 5. 代码示例

请求示例

```bach
GET https://api.weixin.qq.com/wxa/security/get_privacy_interface?access_token=ACCESS_TOKEN
```

返回示例

```json
{
  "errcode": 0,
  "errmsg": "ok",
  "interface_list": [
    {
      "api_name": "wx.chooseAddress",
      "api_ch_name": "获取用户收货地址",
      "api_desc": "调起用户编辑收货地址原生界面，并在编辑完成后返回用户选择的地址。",
      "status": 1,
      "api_link": "/miniprogram/dev/api/open-api/address/wx.chooseAddress.md",
      "group_name": "地理位置"
    },
    {
      "api_name": "wx.choosePoi",
      "api_ch_name": "选择位置，支持模糊定位（精确到市）和精确定位混选",
      "api_desc": "选择位置，支持模糊定位和精确定位混选",
      "status": 4,
      "audit_id": 421610267,
      "fail_reason": "小程序内未含有相应使用场景",
      "api_link": "/miniprogram/dev/api/location/wx.choosePoi.md",
      "group_name": "地理位置"
    },
    {
      "api_name": "wx.getLocation",
      "api_ch_name": "获取当前的地理位置、速度 ",
      "api_desc": "获取当前的地理位置、速度。当用户离开小程序后，此接口无法调用。 ",
      "status": 1,
      "api_link": "/miniprogram/dev/api/location/wx.getLocation.md ",
      "group_name": "地理位置"
    },
    {
      "api_name": "wx.onLocationChange",
      "api_ch_name": "监听实时地理位置变化事件",
      "api_desc": "监听实时地理位置变化事件。当用户离开小程序后，此接口无法调用。",
      "status": 1,
      "api_link": "/miniprogram/dev/api/location/wx.onLocationChange.md",
      "group_name": "地理位置"
    },
    {
      "api_name": "wx.chooseLocation",
      "api_ch_name": "打开地图选择位置",
      "api_desc": "打开地图选择位置。",
      "status": 1,
      "api_link": "/miniprogram/dev/api/location/wx.chooseLocation.md",
      "group_name": "地理位置"
    }
  ]
}
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "0",
    "错误描述": "ok",
    "解决方案": "ok"
  },
  {
    "错误码": "61031",
    "错误描述": "our last submission is under review, please do not apply again",
    "解决方案": "审核中，请不要重复申请"
  }
]
```

## 7. 适用范围

本接口支持「第三方平台」账号类型代调用，权限集请参考「调用方式」部分。其他账号类型如无特殊说明，均不可调用。