Skip to content

获取文件编辑信息(包含水印、权限等)

请求说明

请求地址回调地址 + uri(默认为:/v1/3rd/edit/info
请求方法GET
签名方式

请求头(Header)

名称是否必填说明
Content-Type固定为: application/json
X-Weboffice-File-Id文件id
X-Wps-Weboffice-Token开发者通过JSSDK设置用于用户鉴权TOKEN

查询参数(Query)

名称参数类型是否必填说明
_w_third_*object合作方自定义参数, _w_third_作为前缀,_w_third_appid,_w_third_file_id 字段已被使用,对接方请合理避开

响应体(Response)

正常返回

名称类型是否必填说明
fileobject文件信息
   idstring文件 id,长度 ≤64
   preview_pagesinteger限制预览页数1. 用户操作权限 user.permission 为 write 时,限制不生效2. 用户操作权限 user.permission 为 read 时:   - previewPages 默认值为 0,不限制预览页数   - previewPages >= 1 时,限制生效,限制的页数为 previewPages 字段的值
   user_aclobject用户权限信息
       renameinteger重命名权限1=开启,0=关闭(默认)
       historyinteger历史版本权限1=开启(默认),0=关闭
       manage_perminteger轻维表甘特图设置权限1=开启,0=关闭
       saveasinteger另存权限1=开启,0=关闭
       content_permission_idinteger内容权限 ID(高级权限功能)
       extrastring扩展字段,最大长度 1024(高级权限功能)
       copyinteger复制权限1=开启,0=关闭
       exportinteger导出权限1=开启,0=关闭
       printinteger打印权限1=开启,0=关闭
       commentinteger评论权限1=开启,0=关闭
       copy_controlinteger系统内复制粘贴限制权限1=开启,0=关闭
       edit_shareinteger编辑分享权限1=开启,0=关闭
       can_protectinteger是否可开启保护1=开启,0=关闭(区域权限功能)
       excel_protectioninteger是否开启区域权限保护1=开启,0=关闭(区域权限功能)
   watermarkobject水印配置
       typeinteger水印类型:0=无;1=文字水印
       valuestring文字水印的文字,支持通过\r\n换行,支持emoji表情当type为1时此字段必选
       fillstylestring水印颜色(含透明度),非必选,有默认值格式:rgba(192,192,192,0.6)
       fontstring水印的字体,非必选,有默认值格式:bold 20px Serif若使用默认字体时,需确认环境中已有该字体
       rotatefloat水印的旋转度(弧度),非必选,有默认值默认值:-0.7853982
       horizontalinteger水印水平间距,非必选,有默认值默认值:50
       verticalinteger水印垂直间距,非必选,有默认值默认值:100
userobject用户信息
   idstring用户 id,长度 ≤32
   namestring用户名称
   permissionstring用户权限write=编辑;read=仅预览
   avatar_urlstring用户头像 URL 或 base64
collaboration_switchstring协作开关"open"=开启;"closed"=关闭(默认)

正常返回示例

json
{
    "file": {
        "id": "132aa30a87064",
        "preview_pages": 3,
        "user_acl": {
            "rename": 1,
            "history": 1,
            "manage_perm": 1,
            "saveas": 1,
            "content_permission_id": 123,
            "extra": "扩展信息",
            "copy": 1,
            "export": 1,
            "print": 1,
            "comment": 1,
            "copy_control": 1,
            "edit_share": 1,
            "can_protect": 1,
            "excel_protection": 0
        },
        "watermark": {
            "type": 1,
            "value": "禁止传阅",
            "fillstyle": "rgba( 192, 192, 192, 0.6 )",
            "font": "bold 20px Serif",
            "rotate": -0.7853982,
            "horizontal": 50,
            "vertical": 100
        }
    },
    "user": {
        "id": "id1000",
        "name": "wps-1000",
        "permission": "read",
        "avatar_url": "http://xxx.cn/id=1000"
    },
    "collaboration_switch": "closed"
}

异常返回

名称参数类型是否必填说明
codeinteger错误码
messagestring错误提示
detailsstring错误提示详细信息
hintstring自定义错误信息,当code为40007错误码时必填

异常返回示例

json
{
"code": 40005,
"message":"InvalidArgument",
"details": "参数错误",
"hint": "自定义错误提示"
}