获取国家地区
# 描述
获取国家地区
# 请求说明
请求方式:POST + application/json
请求路径:https://${填入所在云的域名}/cgi/crm/countryAreaOptions/get?thirdTraceId=${随机字符串}
请求头填写 :参考公共参数填写
# 请求参数
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| isIncludeDeleted | Boolean | 是 | 是否获取已删除的省市区信息,默认为true返回已删除的,false不返回已删除的 |
| locale | String | 否 | 语言,zh_CN:中文简体,zh_TW:中文繁体,en:英文 |
# 请求示例
{
"isIncludeDeleted": true,
"locale": "zh_CN"
}
# 返回参数
| 参数 | 类型 | 说明 |
|---|---|---|
| traceId | string | 请求唯一ID |
| errorDescription | string | 错误描述 |
| errorMessage | string | 错误信息 |
| errorCode | Int | 查看错误码 |
# 返回示例
{
"traceId": "E-O.827xxxxxx",
"errorDescription": "success",
"errorMessage": "OK",
"errorCode": 0,
"countryAreaOptions": {
"country": {
"is_index": false,
"is_need_convert": false,
"is_required": false,
"api_name": "country",
"options": [
{
"child_options": [
{
"province": [
"249",
"250",
"251"
]
}
],
"label": "中国",
"value": "248"
},
{
"label": "阿尔巴尼亚",
"value": "0"
},
{
"label": "阿尔及利亚",
"value": "1"
},
{
"label": "阿富汗",
"value": "2"
}
]
}
}
}
# 注意事项
- 不能使用返回值的message字段做逻辑判断,errorMessage会有变化;