Skip to content

查询省份/主要行政区信息

根据国家/地区 ID、省份/主要行政区 ID、状态,批量查询国家/地区下辖的一级行政区(如省份、直辖市、自治区、州等)数据

请求

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

请求头

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

查询参数

名称类型必填描述
page_sizeint分页大小,最大 100
示例值:100
数据校验规则
- 取值范围:1100
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:6891251722631890445

请求体

名称类型必填描述
country_region_id_liststring\[\]国家/地区 ID 列表,可通过查询国家/地区信息接口获取,不填写则返回全部
示例值:["6891251722631891995"]
数据校验规则
- 最大长度:100
country_region_subdivision_id_liststring\[\]省份/主要行政区 ID 列表,不填写则返回全部
示例值:["6891251222631891995"]
数据校验规则
- 最大长度:100
status_listint\[\]状态列表,不填写则返回全部
示例值:[1]
可选值有
- 1: 生效 - 0: 失效
默认值[1]
数据校验规则
- 最大长度:2

请求体示例

json
{
    "country_region_id_list": [
        "6891251722631891995"
    ],
    "country_region_subdivision_id_list": [
        "6891251222631891995"
    ],
    "status_list": [
        1
    ]
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ itemscountry_region_subdivision\[\]查询的省份/主要行政区信息
    └ country_region_subdivision_idstring省份/主要行政区 ID
    └ namei18n\[\]省份/主要行政区名称
      └ langstring语言编码(IETF BCP 47)
      └ valuestring文本内容
    └ country_region_idstring所属国家/地区 ID,详细信息可通过查询国家 / 地区信息接口查询获得
    └ subdivision_typeenum行政区类型,枚举值可通过枚举常量介绍文档中行政区类型(subdivision_type)定义部分获得
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring语言编码(IETF BCP 47)
        └ valuestring文本内容
    └ iso_codestring省份/主要行政区编码(ISO 3166-2)
    └ statusint状态
可选值有
- 1: 生效 - 0: 失效
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ has_moreboolean是否还有更多项

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "country_region_subdivision_id": "6863326571462133262",
                "name": [
                    {
                        "lang": "zh-CN",
                        "value": "中文示例"
                    }
                ],
                "country_region_id": "6862995791674344967",
                "subdivision_type": {
                    "enum_name": "governorate",
                    "display": [
                        {
                            "lang": "zh-CN",
                            "value": "中文示例"
                        }
                    ]
                },
                "iso_code": "PSE-GZA",
                "status": 1
            }
        ],
        "page_token": "6891251722631890445",
        "has_more": true
    }
}

内容来源:飞书开放平台 · 自动爬取整理