公众号
取消
中文
中文
EN
取消
  • 服务端 API

    • # 获取省市区信息

    调试工具

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

    接口英文名：getdistrictlist

    本接口用于获取省市区信息

    # 1. 调用方式

    # HTTPS 调用

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

    # 云调用

    • 本接口不支持云调用

    # 第三方调用

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

    • 该接口所属的权限集 id 为：8-10、13、37

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

    # 2. 请求参数

    # 查询参数 Query String parameters

    参数名类型必填说明
    access_tokenstring是接口调用凭证，可使用 access_token、authorizer_access_token

    # 请求体 Request Payload

    无

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    statusnumber状态码
    messagestring状态描述
    data_versionstring数据版本
    resultobjarray数据内容，此数组是二维数组，分别代表省市区的信息

    # Res.result(Array) Object Payload

    数据内容，此数组是二维数组，分别代表省市区的信息

    参数名类型说明
    idstring区域id，也叫做 districtid
    namestring省市区简要名称
    fullnamestring省市区完整名称
    pinyinarray省市区拼音列表
    locationobject坐标
    cidxnumarray下属地区所有id，可通过此id获取下属地区

    # Res.result(Array).location Object Payload

    坐标

    参数名类型说明
    latstring纬度坐标
    lngstring经度坐标

    # 4. 注意事项

    本接口无特殊注意事项

    # 5. 代码示例

    请求示例

    {}

    返回示例

    {
"status": 0,
"message": "query ok",
"data_version": "20170510",
"result": [
    [{
      "id": "440000",
      "name": "广东",
      "fullname": "广东省",
      "pinyin": [ "guang", "dong"],
      "location": {
        "lat": 23.13171,
        "lng": 113.26627
      },
      "cidx": [246,266]
    }],
    [{
      "id": "440100",
      "name": "广州",
      "fullname": "广州市",
      "pinyin": [ "guang","zhou" ],
      "location": {
        "lat": 23.12908,
        "lng": 113.26436
      },
      "cidx": [1667,1677]
    }],
    [{
      "id": "440105",
      "fullname": "海珠区",
      "location": {
        "lat": 23.08331,
        "lng": 113.3172
      }
    },{
      "id": "440106",
      "fullname": "天河区",
      "location": {
        "lat": 23.12463,
        "lng": 113.36199
      }
    }]
  ]
}

    # 6. 错误码

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

    错误码错误描述解决方案
    40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口

    # 7. 适用范围

    本接口在不同账号类型下的可调用情况：
    小程序公众号服务号
    ✔ ✔ ✔
    • ✔：该账号可调用此接口
    • 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口；