Download OpenAPI specification:
// 获取招募帖子列表
| cursor | string // 分页游标 |
| limit | int64 // 分页大小 |
| location | string // 地点过滤 |
| recruit_status | string Enum: "CompanionRecruitStatusEnum_CompanionRecruitStatusEnum_Invalid" "CompanionRecruitStatusEnum_CompanionRecruitStatusEnum_Recruiting" "CompanionRecruitStatusEnum_CompanionRecruitStatusEnum_RecruitCompleted" "CompanionRecruitStatusEnum_CompanionRecruitStatusEnum_Closed" // 招募状态过滤 |
| tags | string // 标签过滤 |
object (locus.models.params.common.companion.CompanionTimeRange) |
{- "cursor": "string",
- "limit": null,
- "location": "string",
- "recruit_status": "CompanionRecruitStatusEnum_CompanionRecruitStatusEnum_Invalid",
- "tags": "string",
- "time_range": {
- "end_time": null,
- "start_time": null
}
}{- "body": {
- "has_more": null,
- "next_cursor": "string",
- "posts": {
- "author": {
- "avatar": "string",
- "cert_tags": "string",
- "nickname": "string",
- "real_name_verified": null,
- "user_id": "string",
- "user_ip_location": "string"
}, - "can_apply": null,
- "end_time": null,
- "gather_location": {
- "city": "string",
- "country": "string",
- "district": "string"
}, - "member_previews": {
- "avatar": "string",
- "nickname": "string",
- "user_id": "string"
}, - "post_id": "string",
- "publish_location": {
- "city": "string",
- "country": "string",
- "district": "string"
}, - "publish_time": null,
- "recruit_progress": {
- "applying_count": null,
- "joined_count": null,
- "lacking_count": null,
- "recruit_status": "CompanionRecruitStatusEnum_CompanionRecruitStatusEnum_Invalid",
- "recruit_total_count": null,
- "show_progress": null
}, - "show_apply_button": null,
- "start_time": null,
- "summary": "string",
- "tags": {
- "color": "string",
- "name": "string",
- "tag_id": "string"
}, - "title": "string"
}
}, - "code": "string",
- "message": "string"
}// 获取帖子详情
| post_id required | string // 帖子ID |
{- "post_id": "string"
}{- "body": {
- "post": {
- "author": {
- "avatar": "string",
- "cert_tags": "string",
- "nickname": "string",
- "real_name_verified": null,
- "user_id": "string",
- "user_ip_location": "string"
}, - "background": "string",
- "content_blocks": {
- "block_id": "string",
- "block_type": "CompanionContentBlockTypeEnum_CompanionContentBlockTypeEnum_Invalid",
- "image_block": {
- "caption": "string",
- "image": "string"
}, - "sort_no": null,
- "text_block": {
- "text": "string"
}, - "trip_plan_block": {
- "departure": "string",
- "destination": "string",
- "end_time": null,
- "note": "string",
- "start_time": null
}
}, - "interaction": {
- "comment_count": null,
- "favorite_count": null,
- "like_count": null
}, - "post_id": "string",
- "publish_location": {
- "city": "string",
- "country": "string",
- "district": "string"
}, - "publish_time": null,
- "recruit_progress": {
- "applying_count": null,
- "joined_count": null,
- "lacking_count": null,
- "recruit_status": "CompanionRecruitStatusEnum_CompanionRecruitStatusEnum_Invalid",
- "recruit_total_count": null,
- "show_progress": null
}, - "summary": "string",
- "title": "string",
- "viewer_states": {
- "can_apply": null,
- "favorited": null,
- "followed_author": null,
- "has_applied": null,
- "has_joined": null,
- "is_author": null,
- "liked": null
}
}
}, - "code": "string",
- "message": "string"
}// 申请状态变更
| action required | string Enum: "CompanionApplyActionEnum_CompanionApplyActionEnum_Invalid" "CompanionApplyActionEnum_CompanionApplyActionEnum_Apply" "CompanionApplyActionEnum_CompanionApplyActionEnum_CancelApply" "CompanionApplyActionEnum_CompanionApplyActionEnum_ApplyLeave" // 申请动作 |
| post_id required | string // 帖子ID |
{- "action": "CompanionApplyActionEnum_CompanionApplyActionEnum_Invalid",
- "post_id": "string"
}{- "body": {
- "application_status": "CompanionApplicationStatusEnum_CompanionApplicationStatusEnum_Invalid",
- "fail_reason": "string"
}, - "code": "string",
- "message": "string"
}// 招募审核（预留）
| application_id required | string // 申请ID |
| decision required | string Enum: "CompanionReviewDecisionEnum_CompanionReviewDecisionEnum_Invalid" "CompanionReviewDecisionEnum_CompanionReviewDecisionEnum_Approve" "CompanionReviewDecisionEnum_CompanionReviewDecisionEnum_Reject" // 审核结论 |
| post_id required | string // 帖子ID |
| reason | string // 审核理由 |
{- "application_id": "string",
- "decision": "CompanionReviewDecisionEnum_CompanionReviewDecisionEnum_Invalid",
- "post_id": "string",
- "reason": "string"
}{- "body": {
- "todo": {
- "event_name": "string",
- "todo_implemented": null
}
}, - "code": "string",
- "message": "string"
}// 获取评论列表
| cursor | string // 分页游标 |
| limit | int64 // 分页大小 |
| post_id required | string // 帖子ID |
{- "cursor": "string",
- "limit": null,
- "post_id": "string"
}{- "body": {
- "comments": {
- "author": {
- "avatar": "string",
- "cert_tags": "string",
- "nickname": "string",
- "real_name_verified": null,
- "user_id": "string",
- "user_ip_location": "string"
}, - "comment_id": "string",
- "content": "string",
- "created_at": null,
- "parent_comment_id": "string",
- "post_id": "string"
}, - "has_more": null,
- "next_cursor": "string"
}, - "code": "string",
- "message": "string"
}// 切换收藏
| folder_id | string // 收藏夹ID（为空时返回可选收藏夹） |
| post_id required | string // 帖子ID |
{- "folder_id": "string",
- "post_id": "string"
}{- "body": {
- "favorite_count": null,
- "favorited": null,
- "folders": {
- "folder_id": "string",
- "folder_name": "string",
- "posts_count": null,
- "selected": null
}
}, - "code": "string",
- "message": "string"
}// 离队审核（预留）
| decision required | string Enum: "CompanionReviewDecisionEnum_CompanionReviewDecisionEnum_Invalid" "CompanionReviewDecisionEnum_CompanionReviewDecisionEnum_Approve" "CompanionReviewDecisionEnum_CompanionReviewDecisionEnum_Reject" // 审核结论 |
| leave_application_id required | string // 离队申请ID |
| post_id required | string // 帖子ID |
| reason | string // 审核理由 |
{- "decision": "CompanionReviewDecisionEnum_CompanionReviewDecisionEnum_Invalid",
- "leave_application_id": "string",
- "post_id": "string",
- "reason": "string"
}{- "body": {
- "todo": {
- "event_name": "string",
- "todo_implemented": null
}
}, - "code": "string",
- "message": "string"
}// 切换点赞
| post_id required | string // 帖子ID |
{- "post_id": "string"
}{- "body": {
- "like_count": null,
- "liked": null
}, - "code": "string",
- "message": "string"
}// 获取招募队列（预留）
| cursor | string // 分页游标 |
| limit | int64 // 分页大小 |
| post_id required | string // 帖子ID |
{- "cursor": "string",
- "limit": null,
- "post_id": "string"
}{- "body": {
- "has_more": null,
- "items": {
- "applicant_profile": {
- "avatar": "string",
- "cert_tags": "string",
- "nickname": "string",
- "real_name_verified": null,
- "user_id": "string",
- "user_ip_location": "string"
}, - "applicant_user_id": "string",
- "application_id": "string",
- "apply_time": null,
- "post_id": "string",
- "status": "CompanionApplicationStatusEnum_CompanionApplicationStatusEnum_Invalid"
}, - "next_cursor": "string",
- "todo": {
- "event_name": "string",
- "todo_implemented": null
}
}, - "code": "string",
- "message": "string"
}// 上传发布媒体
| client_md5 | string // 客户端文件摘要 |
| content_type | string // 原始内容类型，由 multipart 文件头回填 |
| file | string <binary> // 上传文件内容，由 multipart 解析后回填 |
| file_name | string // 原始文件名，由 multipart 文件头回填 |
| media_type | string // 媒体类型 |
| template_type | string // 模板类型 |
{- "client_md5": "string",
- "content_type": "string",
- "file": "string",
- "file_name": "string",
- "media_type": "string",
- "template_type": "string"
}{- "body": {
- "asset": {
- "asset_id": "string",
- "content_type": "string",
- "cover_url": "string",
- "duration_mills": null,
- "file_size": null,
- "height": null,
- "media_type": "string",
- "url": "string",
- "width": null
}
}, - "code": "string",
- "message": "string"
}// 保存当前草稿
| base_version | int64 // 基准版本 |
object (locus.models.params.common.post.PostComposerPayload) | |
| template_type | string // 模板类型 |
{- "base_version": null,
- "payload": {
- "activity": {
- "activity_type": "string",
- "city": "string",
- "end_time": null,
- "start_time": null
}, - "content_text": "string",
- "locations": {
- "address": "string",
- "latitude": null,
- "location_name": "string",
- "longitude": null
}, - "media_assets": {
- "asset_id": "string",
- "content_type": "string",
- "cover_url": "string",
- "duration_mills": null,
- "file_size": null,
- "height": null,
- "media_type": "string",
- "url": "string",
- "width": null
}, - "mentioned_user_ids": "string",
- "summary": "string",
- "template_type": "string",
- "title": "string",
- "topic_ids": "string",
- "visibility": "string",
- "vote": {
- "end_time": null,
- "options": "string",
- "start_time": null,
- "title": "string"
}
}, - "template_type": "string"
}{- "body": {
- "draft_id": "string",
- "draft_version": null,
- "updated_at": null
}, - "code": "string",
- "message": "string"
}// 获取当前草稿
| template_type | string // 模板类型 |
{- "template_type": "string"
}{- "body": {
- "draft": {
- "draft_id": "string",
- "draft_version": null,
- "payload": {
- "activity": {
- "activity_type": "string",
- "city": "string",
- "end_time": null,
- "start_time": null
}, - "content_text": "string",
- "locations": {
- "address": "string",
- "latitude": null,
- "location_name": "string",
- "longitude": null
}, - "media_assets": {
- "asset_id": "string",
- "content_type": "string",
- "cover_url": "string",
- "duration_mills": null,
- "file_size": null,
- "height": null,
- "media_type": "string",
- "url": "string",
- "width": null
}, - "mentioned_user_ids": "string",
- "summary": "string",
- "template_type": "string",
- "title": "string",
- "topic_ids": "string",
- "visibility": "string",
- "vote": {
- "end_time": null,
- "options": "string",
- "start_time": null,
- "title": "string"
}
}
}, - "draft_exists": null,
- "updated_at": null
}, - "code": "string",
- "message": "string"
}// 发布帖子
| discard_active_draft | bool // 是否丢弃当前激活草稿 |
| draft_id | string // 草稿ID |
| idempotency_token | string // 幂等token |
object (locus.models.params.common.post.PostComposerPayload) |
{- "discard_active_draft": null,
- "draft_id": "string",
- "idempotency_token": "string",
- "payload": {
- "activity": {
- "activity_type": "string",
- "city": "string",
- "end_time": null,
- "start_time": null
}, - "content_text": "string",
- "locations": {
- "address": "string",
- "latitude": null,
- "location_name": "string",
- "longitude": null
}, - "media_assets": {
- "asset_id": "string",
- "content_type": "string",
- "cover_url": "string",
- "duration_mills": null,
- "file_size": null,
- "height": null,
- "media_type": "string",
- "url": "string",
- "width": null
}, - "mentioned_user_ids": "string",
- "summary": "string",
- "template_type": "string",
- "title": "string",
- "topic_ids": "string",
- "visibility": "string",
- "vote": {
- "end_time": null,
- "options": "string",
- "start_time": null,
- "title": "string"
}
}
}{- "body": {
- "post_id": "string",
- "publish_status": "string",
- "publish_time": null
}, - "code": "string",
- "message": "string"
}// 获取帖子详情
| post_id required | string // 帖子ID |
| topic_id | string // 话题ID |
{- "post_id": "string",
- "topic_id": "string"
}{- "body": {
- "post": {
- "activity": {
- "activity_type": "string",
- "city": "string",
- "end_time": null,
- "start_time": null
}, - "author": {
- "avatar": "string",
- "nickname": "string",
- "user_id": "string"
}, - "content_text": "string",
- "locations": {
- "address": "string",
- "latitude": null,
- "location_name": "string",
- "longitude": null
}, - "media_assets": {
- "asset_id": "string",
- "content_type": "string",
- "cover_url": "string",
- "duration_mills": null,
- "file_size": null,
- "height": null,
- "media_type": "string",
- "url": "string",
- "width": null
}, - "mentioned_user_ids": "string",
- "post_id": "string",
- "publish_time": null,
- "summary": "string",
- "template_type": "string",
- "title": "string",
- "topic_ids": "string",
- "visibility": "string",
- "vote": {
- "end_time": null,
- "options": "string",
- "start_time": null,
- "title": "string"
}
}
}, - "code": "string",
- "message": "string"
}// 获取发布模板
| template_type | string // 模板类型 |
{- "template_type": "string"
}{- "body": {
- "draft_key": "string",
- "max_draft_count_per_user": null,
- "template": {
- "activity_enabled": null,
- "content_text_required": null,
- "location_enabled": null,
- "max_media_count": null,
- "media_selector_enabled": null,
- "mention_selector_enabled": null,
- "supported_media_types": "string",
- "supported_visibilities": "string",
- "template_type": "string",
- "title_required": null,
- "topic_selector_enabled": null,
- "visibility_selector_enabled": null,
- "vote_enabled": null
}
}, - "code": "string",
- "message": "string"
}// 取关用户
| unfollow_id | string // 取关id |
| user_id | string // 用户ID |
{- "unfollow_id": "string",
- "user_id": "string"
}{- "body": { },
- "code": "string",
- "message": "string"
}{- "code": "string"
}{- "body": {
- "authorization": "string",
- "is_new_user": null,
- "user_id": "string"
}, - "code": "string",
- "message": "string"
}// 获取互关用户列表
| cursor | string |
| keyword | string |
| limit | int64 |
{- "cursor": "string",
- "keyword": "string",
- "limit": null
}{- "body": {
- "has_more": null,
- "next_cursor": "string",
- "users": {
- "avatar": "string",
- "nickname": "string",
- "user_id": "string",
- "user_short_id": "string"
}
}, - "code": "string",
- "message": "string"
}{- "user_id": "string"
}{- "body": {
- "avatar": "string",
- "desc": "string",
- "gender": "string",
- "location": "string",
- "nickname": "string"
}, - "code": "string",
- "message": "string"
}// 创建用户
| avatar | string // 头像 |
| birth_time | string // 生日 |
| create_by | string Enum: "UserCreateMethodEnum_UserCreateMethodEnum_Invalid" "UserCreateMethodEnum_UserCreateMethodEnum_ByPhone" "UserCreateMethodEnum_UserCreateMethodEnum_ByWechat" // 创建场景 |
| gender | string // 性别 |
| location | string // 所在城市 |
| passport | string // 验证码 |
object (locus.models.params.common.users.CreateUserScene) | |
| ticket | string // 创建凭证，手机号或者微信openid |
{- "avatar": "string",
- "birth_time": "string",
- "create_by": "UserCreateMethodEnum_UserCreateMethodEnum_Invalid",
- "gender": "string",
- "location": "string",
- "passport": "string",
- "scene": {
- "device": {
- "device_id": "string"
}, - "source": {
- "wechat_app_id": "string",
- "wechat_open_id": "string"
}, - "user_ip": "127.0.0.1"
}, - "ticket": "string"
}{- "body": {
- "redirect_url": "string",
- "user_id": "string"
}, - "code": "string",
- "message": "string"
}// 用户编辑
| avatar | string // 头像 |
| desc | string // 个性签名 |
| gender | string Enum: "UserGenderEnum_UserGenderEnum_Invalid" "UserGenderEnum_UserGenderEnum_Male" "UserGenderEnum_UserGenderEnum_Female" // 性别 |
| location | string // 所在城市 |
| nickname required | string // 昵称 |
{- "avatar": "string",
- "desc": "string",
- "gender": "UserGenderEnum_UserGenderEnum_Invalid",
- "location": "string",
- "nickname": "string"
}{- "body": {
- "avatar": "string",
- "desc": "string",
- "gender": "UserGenderEnum_UserGenderEnum_Invalid",
- "location": "string",
- "nickname": "string",
- "user_id": "string"
}, - "code": "string",
- "message": "string"
}{- "user_id": "string"
}{- "body": {
- "achieve_info": {
- "fans_count": "string",
- "follow_count": "string",
- "trips_count": "string"
}, - "avatar": "string",
- "functions": {
- "block": {
- "name": "string",
- "sub_page_link": "string",
- "tags": {
- "icon": "string",
- "link": "string",
- "link_type": "string",
- "name": "string"
}
}, - "prefer": {
- "name": "string",
- "sub_page_link": "string",
- "tags": {
- "icon": "string",
- "link": "string",
- "link_type": "string",
- "name": "string"
}
}, - "trip": {
- "name": "string",
- "sub_page_link": "string",
- "tags": {
- "icon": "string",
- "link": "string",
- "link_type": "string",
- "name": "string"
}
}
}, - "show_info": {
- "background": "string"
}, - "user_id": "string",
- "user_short_id": "string"
}, - "code": "string",
- "message": "string"
}{- "userId": "string"
}{- "body": {
- "chosen": "string",
- "tags": {
- "children": null,
- "chosen": null,
- "id": null,
- "name": "string"
}
}, - "code": "string",
- "message": "string"
}