Sharing a File

Function

Share a file.

Authorization Information

No identity policy-based permission required for calling this API.

URI

POST /koodrive/ose/v1/share

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
Authorization	Yes	String	Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.
X-Traceid	No	String	Service trace ID, which contains 58 bits.
X-User-Id	Yes	String	User ID, which is used for app authentication.
X-Date	Yes	String	Date, which is used for app authentication.
Host	Yes	String	Address, which is used for app authentication.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
scope	Yes	Integer	Sharing scope. 1: users who receive the link (only for whitelisted users); 2: only enterprise users; 3: specified enterprise users.
deptIds	No	Array of strings	Department ID list.
groupIds	No	Array of strings	List of user group IDs.
userIds	No	Array of strings	User ID list.
phoneNumbers	No	Array of strings	User mobile number list (B2B/B2C).
fileIds	Yes	Array of strings	File ID list.
containerId	Yes	String	Space ID.
permission	No	SharePermission object	Sharing permission (supported in the future).
extractCode	No	String	Access code.
expireTime	No	String	Expiration time.
comment	No	String	Sharing message.
validDays	Yes	Integer	Sharing validity period. Value range: 1 to 365 days.

**Table 3** SharePermission
Parameter	Mandatory	Type	Description
preview	No	Boolean	Preview permission.
edit	No	Boolean	Editing permission.
download	No	Boolean	Download permission.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
code	String	Response code.
msg	String	Response information.
shareLink	shareLink object	Sharing link information.

**Table 5** shareLink
Parameter	Type	Description
shareId	String	Sharing ID.
shortUrl	String	Sharing short code.
linkUrl	String	Sharing link.
extractCode	String	Access code.
comment	String	Message.
expireTime	String	Expiration time.

Example Requests

POST /koodrive/ose/v1/share

Authorization:Bearer+10f88**********4791e9ff

{
  "scope": 0,
  "deptIds": [
    "string"
  ],
  "groupIds": [
    "string"
  ],
  "userIds": [
    "string"
  ],
  "fileIds": [
    "string"
  ],
  "containerId": "string",
  "permission": {
    "preview": true,
    "edit": true,
    "download": true
  },
  "extractCode": "string",
  "expireTime": "2024-06-03T01:54:57.288Z",
  "comment": "string",
  "validDays": 0
}

Example Responses

Status code: 200

{
  "shareLink" : {
    "shareId" : "1537770199275722240",
    "shortUrl" : "1537770199275722241",
    "linkUrl" : "https://kdconsole-test-gray.hwcloudtest.cn:8080/cloudfile/#/sharelink/i/1537770199275722241",
    "extractCode" : "",
    "comment" : "",
    "expireTime" : "2024-10-29T09:14:52.948Z"
  },
  "code" : 0,
  "msg" : "success"
}