Inviting a Member to Join a Shared Folder
Function
Invite a member to join a shared folder.
URI
POST /koodrive/ose/v1/usergroupsInvite/invite/{groupId}
Parameter | Mandatory | Type | Description |
|---|---|---|---|
groupId | Yes | Long | Definition: User group ID. Constraints: N/A Range: N/A Default Value: N/A |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
mobile | Yes | String | Definition: Mobile number of the invitee. Constraints: 4-digit international area code + mobile number. Example: 0027821234567 Range: N/A Default Value: N/A |
Request Parameters
Parameter | Mandatory | Type | Description |
|---|---|---|---|
Authorization | Yes | String | Definition: 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}. Constraints: N/A Range: N/A Default Value: N/A |
X-Traceid | No | String | Definition: Service trace ID, which contains 58 bits. Constraints: N/A Range: The value contains 58 bits. Default Value: N/A |
language | No | String | Definition: Language code. Constraints: The value must comply with the internationalization specifications. For example, en_us indicates English (United States). Range: The value must comply with the internationalization specifications. Default Value: en-US |
X-User-Id | Yes | String | Definition: User ID on KooDrive, which is used for app authentication. Constraints: N/A Range: N/A Default Value: N/A |
X-Date | Yes | String | Definition: Date, which is used for app authentication. Constraints: The format is yyyyMMDD'T'HHmmss'Z', for example, 20251103T070140Z. Range: The value must be within 15 minutes from the current time and cannot be later than the current time. Default Value: N/A |
Response Parameters
Status code: 200
Parameter | Type | Description |
|---|---|---|
inviteId | String | Primary key ID of an invitation record. |
code | Integer | Response code. |
msg | String | Response. |
Example Requests
Example request for inviting a member to join a shared folder.
/koodrive/ose/v1/usergroupsInvite/invite/1763204937392700288 param:mobile=0027***38
Example Responses
Status code: 200
Invite a member to join a shared folder.
{
"inviteId" : "17651****7249",
"code" : 0,
"msg" : "success"
} Status Codes
Status Code | Description |
|---|---|
200 | Invite a member to join a shared folder. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
