# 获取地址行政编码

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:getaddresscode

通过该接口可获取地址行政编码信息,最多获取4级地址的行政编码。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/channels/ec/basics/addresscode/get?access_token=ACCESS_TOKEN

# 云调用

  • 调用方法:channels.ec.basics.addresscode.get

  • 出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档

# 第三方调用

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

  • 该接口所属的权限集 id 为:129、131

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
addr_codenumber地址行政编码,不填或者填0时,获取全国的省级行政编码

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
addrs_msgobject本行政编码地址信息
next_level_addrsobjarray下一级所有地址信息

# Res.addrs_msg Object Payload

本行政编码地址信息

参数名类型说明
namestring地址名称
codenumber地址行政编码
levelnumber地址级别 1-省级 2-市级 3-区县级 4-街道

# Res.next_level_addrs(Array) Object Payload

下一级所有地址信息

参数名类型说明
namestring地址名称
codenumber地址行政编码
levelnumber地址级别 1-省级 2-市级 3-区县级 4-街道

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
    "addr_code":0
}

返回示例

{
    "errcode": 0,
    "errmsg": "ok",
    "addrs_msg": {
        "name": "中华人民共和国",
        "code": 0,
        "level": 0
    },
    "next_level_addrs": [
        {
            "name": "澳门特别行政区",
            "code": 820000000,
            "level": 1
        },
        {
            "name": "香港特别行政区",
            "code": 810000000,
            "level": 1
        },
        {
            "name": "宁夏回族自治区",
            "code": 640000000,
            "level": 1
        },
        {
            "name": "青海省",
            "code": 630000000,
            "level": 1
        },
        {
            "name": "甘肃省",
            "code": 620000000,
            "level": 1
        },
        {
            "name": "贵州省",
            "code": 520000000,
            "level": 1
        },
        {
            "name": "西藏自治区",
            "code": 540000000,
            "level": 1
        },
        {
            "name": "四川省",
            "code": 510000000,
            "level": 1
        },
        {
            "name": "江苏省",
            "code": 320000000,
            "level": 1
        },
        {
            "name": "河南省",
            "code": 410000000,
            "level": 1
        },
        {
            "name": "台湾省",
            "code": 710000000,
            "level": 1
        },
        {
            "name": "辽宁省",
            "code": 210000000,
            "level": 1
        },
        {
            "name": "上海市",
            "code": 310000000,
            "level": 1
        },
        {
            "name": "福建省",
            "code": 350000000,
            "level": 1
        },
        {
            "name": "黑龙江省",
            "code": 230000000,
            "level": 1
        },
        {
            "name": "湖北省",
            "code": 420000000,
            "level": 1
        },
        {
            "name": "新疆维吾尔自治区",
            "code": 650000000,
            "level": 1
        },
        {
            "name": "陕西省",
            "code": 610000000,
            "level": 1
        },
        {
            "name": "吉林省",
            "code": 220000000,
            "level": 1
        },
        {
            "name": "河北省",
            "code": 130000000,
            "level": 1
        },
        {
            "name": "天津市",
            "code": 120000000,
            "level": 1
        },
        {
            "name": "北京市",
            "code": 110000000,
            "level": 1
        },
        {
            "name": "浙江省",
            "code": 330000000,
            "level": 1
        },
        {
            "name": "重庆市",
            "code": 500000000,
            "level": 1
        },
        {
            "name": "江西省",
            "code": 360000000,
            "level": 1
        },
        {
            "name": "安徽省",
            "code": 340000000,
            "level": 1
        },
        {
            "name": "山东省",
            "code": 370000000,
            "level": 1
        },
        {
            "name": "湖南省",
            "code": 430000000,
            "level": 1
        },
        {
            "name": "云南省",
            "code": 530000000,
            "level": 1
        },
        {
            "name": "内蒙古自治区",
            "code": 150000000,
            "level": 1
        },
        {
            "name": "山西省",
            "code": 140000000,
            "level": 1
        },
        {
            "name": "广东省",
            "code": 440000000,
            "level": 1
        },
        {
            "name": "广西壮族自治区",
            "code": 450000000,
            "level": 1
        },
        {
            "name": "海南省",
            "code": 460000000,
            "level": 1
        }
    ]
}



# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
10021402无效的地址编码

# 7. 适用范围

本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。