# 获取地址列表

获取地址列表，可查询到的信息包括地址与地点信息，可应用在职位地点、面试地点、人才意向工作城市等场景。

## 名词解释
地点和地址的描述如下：
- 地点：行政区域划分，如 「中国大陆」、「四川省」、「成都市」、「高新区」

- 地址：具体地理位置，包括职位地址、面试地址、门店地址，如：「中国四川省成都市成华区熊猫大道 1375 号」

## 请求

基本 |  
---|---
HTTP URL | https://open.feishu.cn/open-apis/hire/v1/locations
HTTP Method | GET
接口频率限制 | [20 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 获取招聘相关位置信息(hire:location:readonly)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)

### 查询参数

名称 | 类型 | 必填 | 描述
---|---|---|---
page_token | string | 否 | 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果<br>**示例值**：eyJvZmZzZXQiOjEwLCJ0aW1lc3RhbXAiOjE2Mjc1NTUyMjM2NzIsImlkIjpudWxsfQ==
page_size | int | 否 | 每页获取记录数量<br>**示例值**：100<br>**默认值**：`10`<br>**数据校验规则**：<br>- 最大值：`100`
usage | string | 是 | 地址类型<br>**示例值**：interview_location<br>**可选值有**：<br>- position_location：职位地址<br>- interview_location：面试地址<br>- store_location：门店地址。当前仅支持未接入飞书人事的租户使用

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
items | location\[\] | 地址和地点信息列表
id | string | 地址 ID
name | i18n | 地址名称
zh_cn | string | 地址中文名称
en_us | string | 地址英文名称
district | code_name_object | 区信息
code | string | 区编码
name | i18n | 区名称
zh_cn | string | 区中文名称
en_us | string | 区英文名称
city | code_name_object | 市信息
code | string | 市编码
name | i18n | 市名称
zh_cn | string | 市中文名称
en_us | string | 市英文名称
state | code_name_object | 省份/州信息
code | string | 省份/州编码
name | i18n | 省份/州名称
zh_cn | string | 省份/州中文名称
en_us | string | 省份/州英文名称
country | code_name_object | 国家信息
code | string | 国家编码
name | i18n | 国家名称
zh_cn | string | 国家中文名称
en_us | string | 国家英文名称
active_status | int | 地址启用状态<br>**可选值有**：<br>- 1：已启用<br>- 2：已禁用
has_more | boolean | 是否还有更多项
page_token | string | 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "id": "1213213123123",
                "name": {
                    "zh_cn": "中国四川省成都市成华区熊猫大道 1375 号",
                    "en_us": "No. 1375, Panda Avenue, Chenghua District, Chengdu, Sichuan, China"
                },
                "district": {
                    "code": "MDCA00009061",
                    "name": {
                        "zh_cn": "高新区",
                        "en_us": "Gaoxin"
                    }
                },
                "city": {
                    "code": "CT_22",
                    "name": {
                        "zh_cn": "成都",
                        "en_us": "Chengdu"
                    }
                },
                "state": {
                    "code": "ST_15",
                    "name": {
                        "zh_cn": "四川",
                        "en_us": "Sichuan"
                    }
                },
                "country": {
                    "code": "CN_1",
                    "name": {
                        "zh_cn": "中国大陆",
                        "en_us": "Chinese Mainland"
                    }
                },
                "active_status": 1
            }
        ],
        "has_more": true,
        "page_token": "eyJvZmZzZXQiOjEwLCJ0aW1lc3RhbXAiOjE2Mjc1NTUyMjM2NzIsImlkIjpudWxsfQ=="
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
500 | 1002001 | 系统错误 | 请根据实际报错信息定位或咨询[技术支持](https://applink.feishu.cn/TLJpeNdW)
400 | 1002002 | 参数错误 | 检查参数是否正确，例如类型，大小