Skip to content

开启文件分享

适用版本>=v7.0.2308b.20230824

接口说明:开启分享

请求说明

请求地址配置域名+/graph+/v7/drives/{drive_id}/files/{file_id}/open_link
请求方法POST
签名方式WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名)
权限要求管理文件分享(用户授权) kso.file.share.write 应用管理文件分享(应用授权) kso.appdrive.file.share.write

请求头(Header)

名称是否必填说明
Content-Type固定为: application/json
Wps-Docs-Date取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT
Wps-Docs-Authorization计算方法参考签名说明
Authorization授权凭证,格式为: Bearer {access_token}

路径参数(Path)

名称参数类型是否必填说明
drive_idstring驱动盘id,<= 1024 characters
file_idstring文件id,<= 1024 characters

请求体(Body)

名称类型是否必填说明
optsobject链接选项
allow_perm_applybool允许申请权限
check_codestring访问密码,<= 1024 characters
close_after_expirebool过期后取消分享链接
expire_periodint过期时长,Enum: 0 7 30
expire_timeint过期时间点
role_idstring权限角色,<= 1024 characters。
支持仅查看view_only、可编辑editable、可评论commentable、可管理manageable、可分享shareable、禁止访问prohibited和自定义权限角色 (自定义权限角色请通过获取文档权限角色列表获取role_id)
scopestring权限范围,users: 仅指定人;company:本企业内;login_users:本系统用户(多租户场景使用)

请求体示例

{
  "opts": {
    "allow_perm_apply": true,
    "check_code": "string",
    "close_after_expire": true,
    "expire_period": 0,
    "expire_time": 0
  },
  "role_id": "string",
  "scope": "company"
}

响应体(Response)

名称类型说明
codeintegercode
detailstringdetail
msgstringmsg
dataobjectnull

响应体示例

{
  "data": null,
  "code": 0,
  "detail": "string",
  "msg": "string"
}