查询传输进度
适用版本>=v7.0.2412b.20241226
接口说明:查询传输进度
请求说明
| 请求地址 | 配置域名+/openapi+/v7/filetransfer/transfer/percent |
|---|---|
| 请求方法 | POST |
| 签名方式 | KSO-1(配置域名+/openapi不参与签名) |
| 权限要求 | 文件摆渡(应用授权) kso.filetransfer.readwrite |
请求头(Header)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| Content-Type | string | 是 | 使用:application/json |
| X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
| X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
| Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
请求体(Body)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| account_id | string | 是 | 三方用户ID |
| account_type | string | 是 | 可选值:third_user, 表示account_id为三方用户ID |
| file_ids | string[] | 否 | 文件ID数组, 最大200个,非必传,不传则查该用户正在传输的文件列表 |
请求体示例
json
{
"account_id": "1",
"account_type": "third_user",
"file_ids": [""]
}响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| data | object[] | |
| ∟ file_id | string | 文件id |
| ∟ name | string | 文件名称 |
| ∟ file_type | string | 文件类型 |
| ∟ stage | integer | 传输阶段 |
| ∟ status | integer | 传输状态 |
| ∟ fail_type | string | 错误类型 |
| ∟ fail_detail | string | 错误详情 |
| ∟ transfer_start | integer | 传输开始时间戳,单位秒 |
| ∟ transfer_end | integer | 传输结束时间,单位秒 |
| ∟ finish_end | integer | 完成时间,单位秒 |
| ∟ scan_preview_url | string | 扫描预览地址 |
| ∟ approval_preview_url | string | 审批预览地址 |
| ∟ extra | string | 额外信息 |
| code | int | 错误码 |
| msg | string | 状态信息 |
| detail | string | 详细信息 |
响应体示例
json
{
"code": 20000000,
"msg": "ok",
"data": [
{
"task_id": "",
"file_id": "",
"name": "",
"file_type": "",
"stage": 0,
"status": 0,
"fail_type": "",
"fail_detail": "",
"transfer_start": 0,
"transfer_end": 0,
"finish_end": 0
}
]
}stage说明
| 状态码 | 说明 |
|---|---|
| 0 | 初始阶段 |
| 20 | 扫描完成 |
| 30 | 审批完成 |
| 50 | 待传输 |
| 51 | 传输中 |
| 80 | 传输完成 |
| 100 | 完成 |
status说明
| 状态码 | 说明 |
|---|---|
| 0 | 初始阶段 |
| 1 | 提交 |
| 2 | 成功 |
| -1 | 失败 |
fail_type说明
| 类型 | 说明 |
|---|---|
| audit_deny | 申请未通过 |
| exits_sensitive | 存在敏感词 |
| maybe_virus | 疑似病毒 |
| network_error | 网络错误 |
| targetUser_NotFound | 目标网域用户不存在 |
| unSupport_fileType | 不支持的文件类型 |