# 申请地理位置接口

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

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

接口英文名：applyPrivacyInterface

- 该接口用于申请地理位置接口。
- 从2022年4月18日开始，部分小程序前端api需申请后，方可使用。该接口用于发起申请使用小程序地理位置相关的 jsapi 。发起申请后可通过[get_privacy_interface](api_getprivacyinterface)查看审核状态。
- 每个接口都有类目要求，申请之前建议先阅读api原文，详细查看类目要求。
- [小程序地理位置接口申请与使用指引](/doc/oplatform/Third-party_Platforms/2.0/product/apply_privacy_api.md)
- **申请地理位置相关接口需要提供与小程序实际使用场景相关的图片或者视频，如未提供以上任一任何信息（url_list、pic_list、video_list）或重复机械提交，将无法提交申请。**

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/wxa/security/apply_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`

```json
[
  {
    "参数名": "api_name",
    "类型": "string",
    "必填": "是",
    "说明": "申请的 api 英文名，例如wx.choosePoi，严格区分大小写"
  },
  {
    "参数名": "content",
    "类型": "string",
    "必填": "是",
    "说明": "申请说原因，不超过300个字符；需要以utf-8编码提交，否则会出现审核失败"
  },
  {
    "参数名": "url_list",
    "类型": "array",
    "必填": "否",
    "说明": "(辅助网页)例如，上传官网网页链接用于辅助审核；url_list、pic_list、video_list三选一填写"
  },
  {
    "参数名": "pic_list",
    "类型": "array",
    "必填": "否",
    "说明": "(辅助图片)填写图片的url ，最多10个；url_list、pic_list、video_list三选一填写"
  },
  {
    "参数名": "video_list",
    "类型": "array",
    "必填": "否",
    "说明": "(辅助视频)填写视频的链接 ，最多支持1个；视频格式只支持mp4格式；url_list、pic_list、video_list三选一填写"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "audit_id",
    "类型": "number",
    "说明": "审核id"
  }
]
```

## 4. 注意事项

- 280个请求/min
- 需要以utf-8编码提交，否则审核失败。
- 申请地理位置相关接口需要提供与小程序实际使用场景相关的图片或者视频，如未提供以上任一任何信息（url_list、pic_list、video_list）或重复机械提交，将无法提交申请。

# 其他说明 

### 审核结果推送

- 审核结果推送至第三方平台-开发资料-[消息与事件url](/doc/oplatform/Third-party_Platforms/2.0/operation/thirdparty/prepare.md#_6%E3%80%81%E6%B6%88%E6%81%AF%E4%B8%8E%E4%BA%8B%E4%BB%B6%E6%8E%A5%E6%94%B6%E9%85%8D%E7%BD%AE)。接收到的消息体如下：

```xml
<xml>
  <ToUserName><![CDATA[gh_fb9688c2a4b2]]></ToUserName>
  <FromUserName><![CDATA[od1P50M-fNQI5Gcq-trm4a7apsU8]]></FromUserName>
  <CreateTime>1488856741</CreateTime>
  <MsgType><![CDATA[event]]></MsgType>
  <Event><![CDATA[wxa_privacy_apply]]></Event>
  <result_info>
      <api_name>"wx.choosePoi"</api_name>
      <apply_time>"1644805538"</apply_time>
      <audit_id>"421609337"</audit_id>
      <audit_time>"1644828435"</audit_time>
      <reason>"小程序内未含有相应使用场景"</reason>
      <status>"2"</status>
  </result_info>
</xml>
```

### status状态说明

| 状态码 | 说明       |
| ------ | ---------- |
| 2      | 审核不通过     |
| 3      | 审核通过     |

## 5. 代码示例

请求示例

```json
{
  "api_name": "wx.test",
  "content": "1312",
  "pic_list": [
    "pic_url1",
    "pic_url2"
  ],
  "video_list": [
    "video_url1",
    "video_ul2"
  ],
  "url_list": [
    "url1",
    "url2"
  ]
}
```

返回示例

```json
{
  "errcode": 0,
  "errmsg": "getuserriskrank succ",
  "audit_id": 123456
}
```

## 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",
    "解决方案": "审核中，请不要重复申请"
  },
  {
    "错误码": "61032",
    "错误描述": "invalid video type, need mp4-type",
    "解决方案": "视频格式不对，要传mp4格式的"
  },
  {
    "错误码": "61033",
    "错误描述": "the media upload fail, please try again",
    "解决方案": "视频下载失败"
  },
  {
    "错误码": "61034",
    "错误描述": "invalid args, please check",
    "解决方案": "必填的参数没填，检查后重新提交"
  },
  {
    "错误码": "61035",
    "错误描述": "the api not need apply",
    "解决方案": "输入的api（api_name严格区分大小写）无需申请，可以直接使用；或者就是api_name输入错了；或者就是这个 api 已经申请了，不需要再申请"
  },
  {
    "错误码": "61036",
    "错误描述": "the appid is not allowed to apply the api",
    "解决方案": "该帐号不可申请，请检查类目是否符合"
  },
  {
    "错误码": "61037",
    "错误描述": "the encoding of content is invalid, need utf-8",
    "解决方案": "需要以utf-8的编码格式提交"
  },
  {
    "错误码": "61038",
    "错误描述": "apply api too frequently",
    "解决方案": "调用频率太快了，不可超过280个请求/min"
  }
]
```

## 7. 适用范围

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