查询城市信息

根据城市 ID、上级省份/主要行政区 ID ，查询城市（自治区、地区、县「美」、町、村「日」）信息

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/corehr/v2/basic_info/cities/search
HTTP Method	POST
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	corehr:common_data.basic_data:read 获取基础数据信息

请求头

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

查询参数

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

请求体

名称	类型	必填	描述
country_region_subdivision_id_list	string\[\]	否	省份/行政区 ID 列表，可通过查询省份/主要行政区信息接口获取，不填则返回全部 示例值：["6863326768128853512"] 数据校验规则： - 最大长度：100
city_id_list	string\[\]	否	城市 ID 列表，不填则返回全部 示例值：["7316867189968012837"] 数据校验规则： - 最大长度：100
status_list	int\[\]	否	状态列表，不填则返回全部 示例值：[1] 可选值有： - 1: 生效 - 0: 失效 默认值：[1] 数据校验规则： - 最大长度：2

请求体示例

{
    "country_region_subdivision_id_list": [
        "6863326768128853512"
    ],
    "city_id_list": [
        "7316867189968012837"
    ],
    "status_list": [
        1
    ]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	city\[\]	查询到的城市列表
└ city_id	string	城市 ID
└ name	i18n\[\]	城市名称
└ lang	string	语言编码（IETF BCP 47）
└ value	string	文本内容
└ country_region_subdivision_id	string	所属省份/行政区 ID，详细信息可通过查询省份/行政区信息接口查询获得
└ code	string	城市三位字母代码
└ subregion_code	string	行政区划代码
└ status	int	状态 可选值有： - 1: 生效 - 0: 失效
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "city_id": "6863333352603125255",
                "name": [
                    {
                        "lang": "zh-CN",
                        "value": "中文示例"
                    }
                ],
                "country_region_subdivision_id": "6863326262757164551",
                "code": "HRB",
                "subregion_code": "230100",
                "status": 1
            }
        ],
        "page_token": "7316867189967963685",
        "has_more": true
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	1160998	Internal Server Error	服务内部错误，请稍后重试。如有问题请联系技术支持