Skip to content

查询传输进度

适用版本>=v7.0.2412b.20241226

接口说明:查询传输进度

请求说明

请求地址配置域名+/openapi+/v7/filetransfer/transfer/percent
请求方法POST
签名方式KSO-1(配置域名+/openapi不参与签名)
权限要求文件摆渡(应用授权) kso.filetransfer.readwrite

请求头(Header)

名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

请求体(Body)

名称类型是否必填说明
account_idstring三方用户ID
account_typestring可选值:third_user, 表示account_id为三方用户ID
file_idsstring[]文件ID数组, 最大200个,非必传,不传则查该用户正在传输的文件列表

请求体示例

json
{
  "account_id": "1",
  "account_type": "third_user",
  "file_ids": [""]
}

响应体(Response)

名称类型说明
dataobject[]
file_idstring文件id
namestring文件名称
file_typestring文件类型
stageinteger传输阶段
statusinteger传输状态
fail_typestring错误类型
fail_detailstring错误详情
transfer_startinteger传输开始时间戳,单位秒
transfer_endinteger传输结束时间,单位秒
finish_endinteger完成时间,单位秒
scan_preview_urlstring扫描预览地址
approval_preview_urlstring审批预览地址
extrastring额外信息
codeint错误码
msgstring状态信息
detailstring详细信息

响应体示例

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不支持的文件类型