查询下级地区列表
使用场景： 获取下级地区列表
权限说明
| 权限项 | 说明 | 备注 |
|---|---|---|
| 应用是否需要申请白名单 | 不需要 | |
| 应用凭证 | 支持 | - |
请求方式： GET（HTTPS）
请求地址： https://test-oapi.epaas.qq.com/common/area/list_sub
Query参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| suite_access_token | string | 是 | 接口调用凭证 |
| parent_id | uint32 | 否 | 地区id,默认返回全部国家 (中国:312829) |
请求示例：
GET https://test-oapi.epaas.qq.com/common/area/list_sub?suite_access_token=ACCESS_TOKEN&parent_id=312829
返回参数：
| 参数 | 类型 | 说明 |
|---|---|---|
| errcode | int32 | 返回码 |
| errmsg | string | 对返回码的文本描述内容 |
| data_list | []object | 地区列表 |
| data_list.id | uint32 | 地区id |
| data_list.name | string | 名称 |
| data_list.level | uint32 | 级别 0:国家，0:省，1:城市，2:地区 |
| data_list.parent_id | uint32 | 父地区id |
| data_list.code | uint32 | 地区编码 |
返回示例：
{
"errcode": 0,
"errmsg": "ok",
"data_list": [
{
"id": "1",
"name": "北京市",
"level": "0",
"code": 110000,
"parent_id": "312829"
},
{
"id": "2",
"name": "上海市",
"level": "0",
"code": 310000,
"parent_id": "312829"
}
]
}
批量查询下级地区列表
使用场景： 批量获取下级地区列表
权限说明
| 权限项 | 说明 | 备注 |
|---|---|---|
| 应用是否需要申请白名单 | 不需要 | |
| 应用凭证 | 支持 | - |
请求方式： POST（HTTPS）
请求地址： https://test-oapi.epaas.qq.com/common/area/batch_list_sub
POST参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| suite_access_token | string | 是 | 接口调用凭证 |
| parent_id_list | []uint32 | 是 | 地区id列表 |
请求示例：
POST https://test-oapi.epaas.qq.com/common/area/batch_list_sub?suite_access_token=ACCESS_TOKEN
请求包体：
{
"parent_id_list": [1,2]
}
返回参数：
| 参数 | 类型 | 说明 |
|---|---|---|
| errcode | int32 | 返回码 |
| errmsg | string | 对返回码的文本描述内容 |
| data_list | []object | 地区列表 |
| data_list.id | uint32 | 地区id |
| data_list.name | string | 名称 |
| data_list.level | uint32 | 级别 0:国家，0:省，1:城市，2:地区 |
| data_list.parent_id | uint32 | 父地区id |
| data_list.code | uint32 | 地区编码 |
返回示例：
{
"errcode": 0,
"errmsg": "ok",
"data_list": [
{
"id": "1",
"name": "北京市",
"level": "0",
"code": 110000,
"parent_id": "312829"
},
{
"id": "2",
"name": "上海市",
"level": "0",
"code": 310000,
"parent_id": "312829"
}
]
}
批量查询地区详情
使用场景： 批量查询地区详情
权限说明
| 权限项 | 说明 | 备注 |
|---|---|---|
| 应用是否需要申请白名单 | 不需要 | |
| 应用凭证 | 支持 | - |
请求方式： POST（HTTPS）
请求地址： https://test-oapi.epaas.qq.com/common/area/batch_get
POST参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| suite_access_token | string | 是 | 接口调用凭证 |
| area_id_list | []uint32 | 是 | 地区id列表 |
请求示例：
POST https://test-oapi.epaas.qq.com/common/area/batch_get?suite_access_token=ACCESS_TOKEN
请求包体：
{
"area_id_list": [1,2]
}
返回参数：
| 参数 | 类型 | 说明 |
|---|---|---|
| errcode | int32 | 返回码 |
| errmsg | string | 对返回码的文本描述内容 |
| data_list | []object | 地区列表 |
| data_list.id | uint32 | 地区id |
| data_list.name | string | 名称 |
| data_list.level | uint32 | 级别 0:国家，0:省，1:城市，2:地区 |
| data_list.parent_id | uint32 | 父地区id |
| data_list.code | uint32 | 地区编码 |
返回示例：
{
"errcode": 0,
"errmsg": "ok",
"data_list": [
{
"id": "1",
"name": "北京市",
"level": "0",
"code": 110000,
"parent_id": "312829"
},
{
"id": "2",
"name": "上海市",
"level": "0",
"code": 310000,
"parent_id": "312829"
}
]
}