API URL
https://baseurl
认证方式
所有接口均在请求头中携带token 进行身份验证
创建任务
创建筛选任务，支持上传文件进行数据筛选
POST
/sh/filter/ct
描述
创建筛选任务，上传待筛选的 txt 文件，指定筛选类型和国家代码。创建成功后返回任务编号，可用于后续查询进度和下载结果。
参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| file | MultipartFile | 必填 | 待筛选的上传文件（仅支持 .txt 格式） |
| filterType | String | 必填 | 筛选类型，见"筛选类型"Tab |
| remark | String | 可选 | 任务描述，默认为"Api Create"，最大长度50 |
| country | String | 可选 | 国家代码 |
响应字段
| 参数名 | 类型 | 说明 |
|---|---|---|
| orderId | String | 创建成功的任务编号 |
| totalNum | Integer | 任务总数。 |
响应示例
{
"code": 200,
"msg": "任务创建成功！",
"data": {
"orderId": "20250602123456789012",
"totalNum": 1000
}
}
查询任务
根据任务编号查询任务详情及进度
GET
/sh/filter/qt
描述
根据任务编号查询任务的当前状态、进度和有效数量等信息。
参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| orderId | String | 必填 | 任务编号 |
响应字段
| 参数名 | 类型 | 说明 |
|---|---|---|
| orderId | String | 任务编号 |
| taskType | String | 任务类型（同 filterType 枚举值） |
| taskStatus | String | 任务状态（Ongoing 进行中, Waiting 排队中, Close 关闭, Finish 任务完成） |
| totalNum | Long | 任务总数。 |
| progressNum | Long | 任务当前进度 |
| effectiveNum | Long | 有效数量 |
响应示例
{
"code": 200,
"msg": "OK",
"data": {
"orderId": "20250602123456789012",
"taskType": "wsYouXiao",
"taskStatus": "Ongoing",
"totalNum": 1000,
"progressNum": 500,
"effectiveNum": 0
}
}
下载任务结果文件（CSV格式）
下载指定任务的筛选结果文件，格式：CSV
GET
/sh/filter/dc
描述
下载指定任务的筛选结果文件，返回 CSV 文件的 GCS 下载地址。
参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| orderId | String | 必填 | 任务编号 |
响应字段
| 参数名 | 类型 | 说明 |
|---|---|---|
| orderId | String | 任务编号 |
| url | String | CSV 文件下载链接（GCS 地址） |
响应示例
{
"code": 200,
"msg": "获取csv下载链接成功",
"data": {
"orderId": "20250602123456789012",
"url": "https://storage.googleapis.com/.../result.csv"
}
}
下载任务结果文件（Excel格式）
下载指定任务的筛选结果文件，格式：Excel
GET
/sh/filter/de
描述
下载指定任务的筛选结果文件，返回 Excel 文件的下载地址。
参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| orderId | String | 必填 | 任务编号 |
响应字段
| 参数名 | 类型 | 说明 |
|---|---|---|
| orderId | String | 任务编号 |
| url | String | Excel 文件下载链接 |
响应示例
{
"code": 200,
"msg": "获取excel下载链接成功",
"data": {
"orderId": "20250602123456789012",
"url": "https://storage.googleapis.com/.../result.xlsx"
}
}
获取用户余额
获取用户可用余额
GET
/sh/filter/gb
描述
获取当前用户的可用余额信息。
参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无参数（token 通过请求头传递） | |||
响应字段
| 参数名 | 类型 | 说明 |
|---|---|---|
| balance | BigDecimal | 用户余额 |
响应示例
{
"code": 200,
"msg": "操作成功",
"data": {
"balance": 48.3541
}
}
获取可用任务类型
获取所有可用的任务类型
GET
/sh/filter/gt
描述
获取当前用户所有可用的筛选任务类型及其单价信息。
参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无参数（token 通过请求头传递） | |||
响应字段
| 参数名 | 类型 | 说明 |
|---|---|---|
| taskCode | String | 任务类型编码 |
| taskName | String | 任务名称 |
| price | String | 单价 |
响应示例
{
"msg": "操作成功",
"code": 200,
"data": [
{
"taskCode": "wsYouXiao",
"price": "0.00006",
"taskName": "WS筛开通"
},
{
"taskCode": "wsHuoYue",
"price": "0.0006",
"taskName": "WS筛活跃"
}
]
}
错误码说明
接口错误码及说明
Error Codes
| Code | 说明 |
|---|---|
| 401 | Token 失效或 token 信息错误 |
| 500 | 请求频繁（查询接口触发频率限制）或服务器内部错误 |
| 502 | 服务重启升级中! 请稍后再试!（10-30秒内再次重试即可） |
| 601 | 任务不存在有效数量！（下载接口，当订单不存在有效账号的时候返回） |
Example Error Response
{
"code": 500,
"msg": "token信息错误！",
"data": null
}
{
"code": 601,
"msg": "任务不存在有效数量！"
}