批量查询国家/地区信息
批量查询国家/地区信息。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/corehr/v1/country_regions |
| HTTP Method | GET |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | corehr:common_data.basic_data:read 获取基础数据信息 corehr:corehr:readonly 获取核心人事信息 corehr:corehr 更新核心人事信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:1231231987 |
page_size | string | 是 | 分页大小 示例值:100 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | country_region\[\] | 国家/地区信息 |
└ id | string | 国家/地区id |
└ name | i18n\[\] | 国家/地区名称 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ alpha_3_code | string | 国家地区三字码 |
└ alpha_2_code | string | 国家地区二字码 |
└ has_more | boolean | 是否还有更多项 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"id": "1",
"name": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"alpha_3_code": "12",
"alpha_2_code": "12"
}
],
"has_more": true,
"page_token": "1234452132"
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 1160101 | marshal error | 检查消息体格式是否符合要求 |
| 500 | 1160102 | unmarshal error | 联系飞书人事 Oncall |
| 500 | 1160103 | request ID repeat | 相同 Request ID 的请求只有第一条会成功,多次请求请更换Request ID |
| 500 | 1160104 | custom field format error | 检查自定义字段格式是否符合元数据定义 |
| 500 | 1160105 | field is required | 检查必填字段是否未填写 |
| 500 | 1160106 | date format should be 2006-01-02 | 检查日期格式是否正确 |
| 400 | 1160107 | param is invalid | 检查调用参数是否正确 |
