查询地点列表

根据地点类型和地点码查询地点列表，获取地点名称信息。

名词解释

地点：行政区域划分，如 「中国大陆」、「四川省」、「成都市」、「高新区」

地址：分为职位地址与面试地址，如：「中国四川省成都市成华区熊猫大道1375号」

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/hire/v1/locations/query
HTTP Method	POST
接口频率限制	5 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	hire:location:readonly 获取招聘相关位置信息

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

查询参数

名称	类型	必填	描述
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：eyJvZmZzZXQiOjEwLCJ0aW1lc3RhbXAiOjE2Mjc1NTUyMjM2NzIsImlkIjpudWxsfQ==
page_size	int	是	每页限制 示例值：100 数据校验规则： - 取值范围：1 ～ 100

请求体

名称	类型	必填	描述
code_list	string\[\]	否	地点码列表，最大长度不超过100，不传则根据地点类型分页查询全量列表 示例值：["CN_1"]
location_type	int	是	地点类型 示例值：1 可选值有： - 1: 国家类型 - 2: 省份/州类型 - 3: 市类型 - 4: 区类型

请求体示例

{
    "code_list": [
        "CN_1"
    ],
    "location_type": 1
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	location_dto\[\]	地点数据列表
└ country	location_country	国家信息列表，仅当 location_type=1 时返回
└ country_code	string	国家Code码
└ country_name_info	location_name_info	国家名称信息聚合
└ zh_name	string	国家中文名
└ en_name	string	国家英文名
└ py_name	string	国家拼音名
└ state	location_state	省份/州信息列表，仅当 location_type=2 时返回
└ state_code	string	省份/州Code码
└ country_code	string	国家Code码
└ state_name_info	location_name_info	省份/州名称信息聚合
└ zh_name	string	省份/州中文名
└ en_name	string	省份/州英文名
└ py_name	string	省份/州拼音名
└ city	location_city	市信息列表，仅当 location_type=3 时返回
└ city_code	string	市Code码
└ state_code	string	省份/州Code码
└ country_code	string	国家Code码
└ city_name_info	location_name_info	市名称信息聚合
└ zh_name	string	市中文名
└ en_name	string	市英文名
└ py_name	string	市拼音名
└ district	location_district	区/县信息列表，仅当 location_type=4 时返回
└ district_code	string	区/县Code码
└ city_code	string	市Code码
└ state_code	string	省份/州Code码
└ country_code	string	国家Code码
└ district_name_info	location_name_info	区/县名称信息聚合
└ zh_name	string	区/县中文名
└ en_name	string	区/县英文名
└ py_name	string	区/县拼音名
└ has_more	boolean	是否还有更多项
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "country": {
                    "country_code": "CN_1",
                    "country_name_info": {
                        "zh_name": "成都",
                        "en_name": "Chinese Mainland",
                        "py_name": "zhongguodalu"
                    }
                },
                "state": {
                    "state_code": "ST_1",
                    "country_code": "CN_1",
                    "state_name_info": {
                        "zh_name": "成都",
                        "en_name": "Liaoning",
                        "py_name": "liaoning"
                    }
                },
                "city": {
                    "city_code": "CT_1",
                    "state_code": "ST_1",
                    "country_code": "CN_1",
                    "city_name_info": {
                        "zh_name": "成都",
                        "en_name": "ChengDu",
                        "py_name": "chengdu"
                    }
                },
                "district": {
                    "district_code": "DS_70",
                    "city_code": "CT_1",
                    "state_code": "ST_1",
                    "country_code": "CN_1",
                    "district_name_info": {
                        "zh_name": "成都",
                        "en_name": "ChengDu",
                        "py_name": "chengdu"
                    }
                }
            }
        ],
        "has_more": true,
        "page_token": "eyJvZmZzZXQiOjEwLCJ0aW1lc3RhbXAiOjE2Mjc1NTUyMjM2NzIsImlkIjpudWxsfQ=="
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	1002001	系统错误	请根据实际报错信息定位或咨询技术支持
400	1002002	参数错误	检查参数是否正确，例如类型，大小