API DocsAPI Docs
post/api/group/{groupId}/join
post/api/group/{groupId}/join
申请加入小组
Basic Information
Request Method:
post
Request URL:
https://www.lycoo.com/api/group/{groupId}/joinTags:
小组成员管理
Description
当前登录用户申请加入指定的小组，申请后用户角色为"等待加入"(pending)。
用途：
- 用户申请加入私有小组
- 申请加入后需要等待管理员审批
- 管理员可以通过 POST /api/group/{groupId}/members 接口将"等待加入"(pending)角色的成员更改为普通成员(member)或管理员(admin)
Path Parameters
Path Parameters Explanation
Path parameters are variables in the URL path, for example:
https://www.lycoo.com/api/group/:groupId/join| Parameter Name | Type | Required | Example Value | Description |
|---|---|---|---|---|
| groupId | string | Required | example | 小组ID |
Header Parameters
Header Parameters Explanation
Header parameters are used to pass additional information, such as authentication credentials, content type, etc.
| Parameter Name | Type | Required | Example Value | Description |
|---|---|---|---|---|
| Authorization | string | Required | Bearer sha_1234567890abcdef... | The authentication header is used to verify the identity of API requests, containing an access token Format: Bearer {token} |
Request Body Parameters
Request Body Parameters Explanation
Request body parameters are used to pass complex structured data, typically using the following format: application/json
Parameter Details
| Parameter Name | Type | Required | Example Value | Description |
|---|---|---|---|---|
| message | string | Optional | 25 | 可选的申请附言 |
JSON Example
{
"message": "我想加入这个小组，一起分享旅行经历"
}Response Example
200申请加入成功，等待审批
{
"success": true,
"message": "申请已提交，等待审批"
}400参数错误
{
"success": false,
"message": "参数错误"
}401
403已经是成员或已有待处理申请
{
"success": false,
"message": "您已经是该小组成员或已有待处理申请"
}404
500