# 获取地址行政编码

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

接口英文名：getaddresscode

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

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 调用方法：channels.ec.basics.addresscode.get

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

- 本接口支持第三方平台代微信小店商家调用。[第三方服务商调用模式介绍](/doc/store/shop/dev_before/third_party_platforms)

- 该接口所属的权限集 id 为：129、131、192

- 服务商获得其中之一权限集授权后，可通过使用 [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",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/doc/store/shop/API/apimgnt/common/api_getaccesstoken)（微信小店商家）、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)（服务商代调用）"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "addr_code",
    "类型": "number",
    "必填": "否",
    "说明": "地址行政编码，不填或者填0时，获取全国的省级行政编码"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "addrs_msg",
    "类型": "object",
    "说明": "本行政编码地址信息"
  },
  {
    "参数名": "next_level_addrs",
    "类型": "objarray",
    "说明": "下一级所有地址信息"
  }
]
```

### Res.addrs_msg `Object Payload`

本行政编码地址信息

```json
[
  {
    "参数名": "name",
    "类型": "string",
    "说明": "地址名称"
  },
  {
    "参数名": "code",
    "类型": "number",
    "说明": "地址行政编码"
  },
  {
    "参数名": "level",
    "类型": "number",
    "说明": "地址级别 1-省级 2-市级 3-区县级 4-街道"
  }
]
```

">

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

下一级所有地址信息

```json
[
  {
    "参数名": "name",
    "类型": "string",
    "说明": "地址名称"
  },
  {
    "参数名": "code",
    "类型": "number",
    "说明": "地址行政编码"
  },
  {
    "参数名": "level",
    "类型": "number",
    "说明": "地址级别 1-省级 2-市级 3-区县级 4-街道"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

请求示例

```json
{
    "addr_code":0
}

```

返回示例

```json
{
    "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. 错误码

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

```json
[
  {
    "错误码": "10021402",
    "错误描述": "无效的地址编码"
  }
]
```

## 7. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "微信小店": "✔",
    "小店供货商": "✔"
  }
]
```

- ✔：该账号可调用此接口。
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。