文件预览
适用版本>=v7.0.2412b.20241226
接口说明:文件预览
请求说明
| 请求地址 | 配置域名+/openapi+/v7/filetransfer/file/preview |
|---|---|
| 请求方法 | 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_id | string | 是 | 文件ID |
| type | string | 是 | 文件格式(w:文字文件,s:表格文件,p:演示文件,f:PDF文件,x:图片或压缩包,d:多维表格,o:轻文档) |
| box | string | 是 | outbox:发件箱 或 inbox:收件箱 |
| expire_time | integer | 否 | 预览链接有效期,单位:秒 (不传默认1小时有效期) |
| preview_mode | string | 否 | 预览模式,可选值:high_definition:高清预览,ordinary:普通预览,cache:缓存预览,official:公文极速预览 (不传默认高清预览) |
| wps_preview | string | 否 | 默认1111111 |
| preview_account_id | string | 是 | 预览用户唯一标识 |
| preview_account_type | string | 是 | 预览用户类型,固定third_user |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| data | object | 返回数据 |
| ∟ url | string | 预览链接 |
| ∟ expiration | string | 过期时间 |
| ∟ preview_token | string | 用于设置weboffice JSSDK |
| code | integer | 错误码 |
| msg | string | 状态信息 |
| detail | string | 详细信息 |
响应体示例
json
{
"code": 20000000,
"detail": "string",
"msg": "string",
"data": {
"url": "string",
"expiration": "string",
"preview_token": "string"
}
}