# 获取区域信息

接口应在服务器端调用,详细说明参见服务端API

# 接口说明

# 接口英文名

queryIcpDistrictCode

# 功能描述

使用该接口查询省市区的区域信息。使用过程中如遇到问题,可在开放平台服务商专区发帖交流

# 注意事项

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

# 调用方式

# HTTPS 调用


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

# 第三方调用

  • 调用方式以及出入参和HTTPS相同,仅是调用的token不同

  • 该接口所属的权限集id为:18、156

  • 服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用

# 请求参数

属性 类型 必填 说明
access_token string 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用 authorizer_access_token

# 返回参数

属性 类型 说明
errcode number 错误码。
errmsg string 错误原因。
items array<object> 区域信息列表
属性 类型 说明
type number 区域类型: 1 -- 省份,2 -- 市,3 -- 区
code number 区域代码
name string 区域名称
sub_list array<object> 下级区域信息列表
属性 类型 说明
type number 区域类型: 1 -- 省份,2 -- 市,3 -- 区
code number 区域代码
name string 区域名称
sub_list array<object> 下级区域信息列表
属性 类型 说明
type number 区域类型: 1 -- 省份,2 -- 市,3 -- 区
code number 区域代码
name string 区域名称

# 调用示例

示例说明: 查询成功示例

# 请求数据示例


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

# 返回数据示例


{
    "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": "胡杨河市"
                        }
                    ]
                }
            ]
        }
    ]
} 

# 错误码

错误码 错误描述 解决方案
0 ok ok
-1 system error 系统繁忙,此时请开发者稍候再试