飞书开放平台 Server API 文档

主题

分页批量查询国家/地区 ​

分页批量查询国家/地区。资源介绍请参考概述。

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/mdm/v3/country_regions
HTTP MethodGET
接口频率限制10 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用mdm:country_region:read 查询国家/地区的公共数据

请求头 ​

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

查询参数 ​

名称类型必填描述
languagesstring\[\]是希望返回的语言种类，支持格式如下： - 中文：zh-CN - 英文：en-US - 日文：ja-JP 对于多语文本字段，传入特定语言，将会返回对应语言文本
示例值：en-US
数据校验规则：
- 长度范围：0 ～ 100
fieldsstring\[\]是需要的查询字段集
示例值：name
数据校验规则：
- 长度范围：1 ～ 100
limitint否查询页大小
示例值：10
数据校验规则：
- 取值范围：1 ～ 1000
offsetint否查询起始位置
示例值：0
数据校验规则：
- 取值范围：0 ～ 100000
return_countboolean否是否返回总数
示例值：true
page_tokenstring否分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
示例值：eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=

请求体 ​

名称类型必填描述
filterfilter否过滤参数
  └ logicstring是逻辑关系同一层级的多个expression由logic参数决定使用“与/或”条件0=and，1=or
示例值："0"
  └ expressionsexpression\[\]否过滤条件
数据校验规则：
- 长度范围：0 ～ 100
    └ fieldstring是字段名
示例值："name"
    └ operatorstring是运算符。0=等于，1=不等于，2=大于，3=大于等于，4=小于，5=小于等于，6=属于任意，7=不属于任意，8=匹配，9=前缀匹配，10=后缀匹配，11=为空，12=不为空
示例值："0"
    └ valuevalue是字段值
      └ string_valuestring否字符串值
示例值："安道尔"
      └ bool_valueboolean否布尔值
示例值：true
      └ int_valuestring否整型值
示例值："111"
      └ string_list_valuestring\[\]否字符串列表值
示例值：["1"]
      └ int_list_valuestring\[\]否整型列表值
示例值：["1"]
commoncommon否此参数可忽略

请求体示例 ​

json
{
    "filter": {
        "logic": "0",
        "expressions": [
            {
                "field": "name",
                "operator": "0",
                "value": {
                    "string_value": "安道尔",
                    "bool_value": true,
                    "int_value": "111",
                    "string_list_value": [
                        "1"
                    ],
                    "int_list_value": [
                        "1"
                    ]
                }
            }
        ]
    },
    "common": {}
}

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ datacountry_region\[\]国家/地区目录列表
    └ alpha_3_codestring三位字母代码。与ISO国家代码的三位代码一致。
    └ alpha_2_codestring两位字母代码。与ISO国家代码的二位代码一致。
    └ numeric_codestring数字代码。与ISO国家代码的Numeric代码一致
    └ namei18n_string国家/地区名称
      └ valuestring入参languages中排序第一的语言对应的值。
      └ multilingual_valuemap<string, string>入参languages中所有语言对应的值。
      └ return_languagestringvalue实际返回的值对应的语言，如"zh-CN"
    └ mdm_codestring主数据编码（系统生成的唯一永久代码，格式为“MDCT+8位数字”）
    └ full_namei18n_string国家/地区全称
      └ valuestring入参languages中排序第一的语言对应的值。
      └ multilingual_valuemap<string, string>入参languages中所有语言对应的值。
      └ return_languagestringvalue实际返回的值对应的语言，如"zh-CN"
    └ global_codestring国际电话区号
    └ statusstring是否生效。0代表否，1代表是
    └ continentsenum所属大洲。可选值如下1-亚洲，2-欧洲，3-非洲，4-北美洲，5-南美洲，6-大洋洲，7-南极洲）
      └ valuestring入参languages中排序第一的语言对应的值。
      └ multilingual_namemap<string, string>入参languages中所有语言对应的值。
  └ totalstring总数
  └ next_page_tokenstring下一次分页参数

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "data": [
            {
                "alpha_3_code": "AND",
                "alpha_2_code": "AD",
                "numeric_code": "20",
                "name": {
                    "value": "安道尔",
                    "multilingual_value": {
                        "zh-CN": "安道尔"
                    },
                    "return_language": "zh-CN"
                },
                "mdm_code": "MDCT00000001",
                "full_name": {
                    "value": "安道尔公国",
                    "multilingual_value": {
                        "zh-CN": "安道尔公国"
                    },
                    "return_language": "zh-CN"
                },
                "global_code": "+376",
                "status": "1",
                "continents": {
                    "value": "2",
                    "multilingual_name": {
                        "zh-CN": "安道尔"
                    }
                }
            }
        ],
        "total": "0",
        "next_page_token": "token"
    }
}

错误码 ​

HTTP状态码错误码描述排查建议
4001640201invalid params参数非法，请检查参数
4001640202param not found参数为空，请检查参数填写是否完整
4001640203object field not found此字段不在查询范围内，请检查
4001640204language is invalid非法语言，请重新填写
4001640205params is required必填参数未填写，请检查
4001640206limit too large查询数量过大，请限制在1000以内
4001640207limit plus offset too large查询数量和起始位置加和过大，请限制在10000以内
4001640208page token invalid分页码无效，请检查该参数
4001640209record id not found未发现符合条件行级记录，请检查查询参数
4001640210sort by null is not allowed排序参数填写有误，请检查
4001640211biz codes is empty业务编码为空，请检查
4001640212mdm codes is empty主数据编码为空，请检查
4001640213biz id is invalid业务编码非法，请检查
5001640101system error系统错误，联系飞书技术支持排查
5001640102invalid generic method请求方法错误，联系飞书技术支持排查
5001640103call meta service error请求元数据方法错误，联系飞书技术支持排查
5001640104meta data not found找不到对应元数据，联系飞书技术支持排查
5001640105data source request invalid数据库请求非法，联系飞书技术支持排查
5001640106db error数据库错误，联系飞书技术支持排查
5001640107func not supported yet服务不支持该方法，联系飞书技术支持排查
5001640108field type not supported yet字段类型不支持，联系飞书技术支持排查
5001640109validator not found未发现数据校验规则，联系飞书技术支持排查
5001640110transformer not found未发现数据转换规则，联系飞书技术支持排查
5001640111executor not found未发现执行器，联系飞书技术支持排查
5001640112invalid data source type错误数据库类型，联系飞书技术支持排查
5001640113data source not found未发现数据库，联系飞书技术支持排查
5001640114data source invalid数据库无效，联系飞书技术支持排查
5001640115meta setting not found未发现元数据配置，联系飞书技术支持排查
5001640116generate page token error分页码生成错误，联系飞书技术支持排查
5001640117record duplicate error行级记录重复，联系飞书技术支持排查
5001640118generate idl erroridl生成错误，联系飞书技术支持排查
5001640119producer not found error消息生产者错误，联系飞书技术支持排查
5001640120custom func request error自定义执行器请求错误，联系飞书技术支持排查
5001640121custom func response error自定义执行器响应错误，联系飞书技术支持排查

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

本镜像仅供学习与查阅，文档版权归飞书所有