Skip to content

文件预览

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

接口说明:文件预览

请求说明

请求地址配置域名+/openapi+/v7/filetransfer/file/preview
请求方法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_idstring文件ID
typestring文件格式(w:文字文件,s:表格文件,p:演示文件,f:PDF文件,x:图片或压缩包,d:多维表格,o:轻文档)
boxstringoutbox:发件箱 或 inbox:收件箱
expire_timeinteger预览链接有效期,单位:秒 (不传默认1小时有效期)
preview_modestring预览模式,可选值:high_definition:高清预览,ordinary:普通预览,cache:缓存预览,official:公文极速预览 (不传默认高清预览)
wps_previewstring默认1111111
preview_account_idstring预览用户唯一标识
preview_account_typestring预览用户类型,固定third_user

响应体(Response)

名称类型说明
dataobject返回数据
urlstring预览链接
expirationstring过期时间
preview_tokenstring用于设置weboffice JSSDK
codeinteger错误码
msgstring状态信息
detailstring详细信息

响应体示例

json
{
  "code": 20000000,
  "detail": "string",
  "msg": "string",
  "data": {
    "url": "string",
    "expiration": "string",
    "preview_token": "string"
  }
}