查询用户传输记录
适用版本>=v7.0.2412b.20241226
接口说明:分页查询用户传输记录
请求说明
| 请求地址 | 配置域名+/openapi+/v7/filetransfer/user/transfers |
|---|---|
| 请求方法 | GET |
| 签名方式 | 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} |
查询参数(Query)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| account_id | string | 是 | 三方用户id |
| account_type | string | 是 | 可选值:third_user, 表示account_id为三方用户ID |
| task_id | string | 否 | 任务ID |
| box | string | 是 | outbox:发件箱 或 inbox:收件箱 |
| status | integer | 否 | -1:失败, 0:初始状态(task传输未提交), 1:传输中, 2:成功 |
| page_size | integer | 是 | 分页大小,默认为:10,最大值:50 |
| page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回next_page_token作为新的page_token,下次遍历可采用该page_token获取查询结果 |
| with_total | boolean | 否 | true: 返回总记录数 false: 不返回总记录数 默认为:false |
| parent_id | 否 | string | parent_id, 筛选对应parent_id下的记录 |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | code |
| detail | string | detail |
| msg | string | msg |
| data | object | 返回信息体 |
| ∟ items | object[] | 传输记录信息 |
| ∟ ∟ task_id | string | 任务ID |
| ∟ ∟ file_id | string | 文件ID |
| ∟ ∟ name | string | 文件名称 |
| ∟ ∟ file_type | string | 文件类型 |
| ∟ ∟ stage | integer | 传输阶段 20-scan/30-audit/50-transfer/51-transfering/100-finish |
| ∟ ∟ status | integer | 传输状态 2:成功 -1:失败 其他传输中 |
| ∟ ∟ size | 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 | 额外信息 |
| ∟ ∟ parent_id | string | parent_id |
| ∟ next_page_token | string | 下一页token;当查询结果中next_page_token为空或无该返回值时,代表无下一页 |
| ∟ total | integer | 总记录数 |
响应体示例
json
{
"code": 20000000,
"msg": "success",
"data": {
"next_page_token": "NDk=",
"total": 0,
"items": [
{
"task_id": "task-7293575166123065344",
"file_id": "7293575167624626176",
"name": "cert",
"file_type": "folder",
"stage": 100,
"status": 2,
"size": 0,
"fail_type": "",
"fail_detail": "",
"transfer_start": 1738923829,
"transfer_end": 1738923829,
"finish_end": 1738923831,
"scan_preview_url": "",
"approval_preview_url": "",
"extra": ""
},
{
"task_id": "296210613239808",
"file_id": "296210613239808",
"name": "filetransfer_2025.02.06_debug.lic",
"file_type": "file",
"stage": 80,
"status": -1,
"size": 1495,
"fail_type": "network_error",
"fail_detail": "收件箱未开启 {\"company_id\":\"4\"} {\"detail\":null}",
"transfer_start": 1738924227,
"transfer_end": 1738924234,
"finish_end": 1738924234,
"scan_preview_url": "",
"approval_preview_url": "",
"extra": ""
}
]
},
"detail": null
}