接口名字
- 接口：common/city/out/fuzzySearch
- Method：GET
- 数据格式：JSON
- 限流信息：3000次/小时
- 接口说明：此接口可以基于输入文本检索云简的标准城市和公司自定义城市。
- 变更历史
参数:
请求参数
| 字段名称 |
字段类型 |
是否必填 |
长度限制(字节) |
字段描述 |
| bizId |
String |
TRUE |
64 |
业务唯一识别码 |
| timestamp |
Long |
TRUE |
13 |
13位时间戳 |
| search_text |
String |
TRUE |
64 |
模糊查询的关键字，会精准匹配city_code，模糊匹配city_name（会匹配所有语言版本的city_name，返回当前语言版本的city_name） |
| size |
Integer |
FALSE |
10 |
返回的数量，不传默认为20，传入值也不可超过100 |
返回参数
| 字段名称 |
字段类型 |
长度限制(字节) |
字段描述 |
| resCode |
Integer |
16 |
响应状态码参考附录二 响应状态码 |
| resMsg |
String |
255 |
响应描述信息 |
| data |
List |
|
响应实体信息 |
| data[*].hot |
Integer |
|
热度，排序时越大越靠前，公司有自定义的是自定义的，没有自定义的按标准产品的 |
| data[*].description |
String |
|
城市描述 |
| data[*].city_code |
String |
|
城市描述 |
| data[*].city_name |
String |
|
城市描述 |
| data[*].city_type |
String |
|
城市分类，是公司自定义的，没有自定义的按标准产品的 |
| data[*].region_code |
String |
|
地区代码 |
| data[*].region_name |
String |
|
地区名字 |
| data[*].nationality_code |
String |
|
国家代码 |
| data[*].nationality_name |
String |
|
国家名字 |
| data[*].enabled_flag |
String |
|
城市是否启用 |
| data[*].is_customizable |
booleon |
|
是否是客户自定义城市，true代表是公司自定义城市，false代表是标准城市 |
示例：
请求数据
https:
返回数据
{
"resCode": 200000,
"resMsg": "success",
"bizId": "xxx",
"data": [
{
"hot": 96,
"description": "北京市北京",
"city_code": "北京",
"city_name": "北京",
"enabled_flag": "Y",
"city_class": "国内",
"city_type": "",
"region_code": "CN1",
"region_name": "北京市",
"nationality_code": "CHN",
"nationality_name": "中国",
"is_customizable": false
}
]
}
变更历史
| 变更日期 |
变更人 |
变更描述 |
| 2025-04-11 |
陈波 |
新增接口 |
| 2026-03-03 |
王文东 |
受城市数据改版影响，取消page_num入参，增加size入参，返回参数取消分页信息 |