# 获取区域信息

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

接口英文名：queryIcpDistrictCode

使用该接口查询省市区的区域信息。使用过程中如遇到问题，可在[小程序备案](https://developers.weixin.qq.com/community/minihome/mixflow/3398116438949937159)专区发帖交流

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 本接口不支持云调用。

### 第三方调用

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

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

- 服务商获得其中之一权限集授权后，可通过使用 [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",
    "说明": "错误原因"
  },
  {
    "参数名": "items",
    "类型": "objarray",
    "说明": "区域信息列表"
  }
]
```

">

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

区域信息列表

```json
[
  {
    "参数名": "type",
    "类型": "number",
    "说明": "区域类型: 1 -- 省份，2 -- 市，3 -- 区"
  },
  {
    "参数名": "code",
    "类型": "number",
    "说明": "区域代码"
  },
  {
    "参数名": "name",
    "类型": "string",
    "说明": "区域名称"
  },
  {
    "参数名": "sub_list",
    "类型": "objarray",
    "说明": "下级区域信息列表"
  }
]
```

__sub_list">

### Res.items(Array).sub_list `Object Payload`

下级区域信息列表

```json
[
  {
    "参数名": "type",
    "类型": "number",
    "说明": "区域类型: 1 -- 省份，2 -- 市，3 -- 区"
  },
  {
    "参数名": "code",
    "类型": "number",
    "说明": "区域代码"
  },
  {
    "参数名": "name",
    "类型": "string",
    "说明": "区域名称"
  },
  {
    "参数名": "sub_list",
    "类型": "objarray",
    "说明": "下级区域信息列表"
  }
]
```

__sub_list__sub_list">

### Res.items(Array).sub_list.sub_list `Object Payload`

下级区域信息列表

```json
[
  {
    "参数名": "type",
    "类型": "number",
    "说明": "区域类型: 1 -- 省份，2 -- 市，3 -- 区"
  },
  {
    "参数名": "code",
    "类型": "number",
    "说明": "区域代码"
  },
  {
    "参数名": "name",
    "类型": "string",
    "说明": "区域名称"
  }
]
```

## 4. 注意事项

1. 该接口返回的结果会不定期更新，切勿对某一次调用的返回结果长期保存或硬编码。
2. 该接口只会返回可用作备案地区的省市区，因此有某些省市区不会被返回，例如香港、澳门、台湾等。

## 5. 代码示例

请求示例

```bach
curl https://api.weixin.qq.com/wxa/icp/query_icp_district_code?access_token=ACCESS_TOKEN
```

返回示例

```json
{
    "errcode": 0,
    "errmsg": "ok",
    "items": [
        {
            "type": 1,
            "code": 110000,
            "name": "北京市",
            "sub_list": [
                {
                    "type": 2,
                    "code": 110100,
                    "name": "市辖区",
                    "sub_list": [
                        {
                            "type": 3,
                            "code": 110101,
                            "name": "东城区"
                        },
                        {
                            "type": 3,
                            "code": 110102,
                            "name": "西城区"
                        },
                        ...
                        {
                            "type": 3,
                            "code": 659010,
                            "name": "胡杨河市"
                        }
                    ]
                }
            ]
        }
    ]
}
```

## 6. 错误码

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

```json
[
  {
    "错误码": "-1",
    "错误描述": "system error",
    "解决方案": "系统繁忙，此时请开发者稍候再试"
  },
  {
    "错误码": "0",
    "错误描述": "ok",
    "解决方案": "ok"
  }
]
```

## 7. 适用范围

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