Files
EchoChat/docs/api/meeting.md
bujinyuan 4458f40025 docs: 完善项目文档体系
- 数据库 SQL 所有字段添加 COMMENT 注释,枚举字段详细标注各值含义
- 新增 docs/architecture/ 系统架构文档(分层架构、数据流、演进路径)
- API 文档按模块拆分为 8 个独立文档(auth/contact/im/meeting/notify/admin/websocket)
- 补充 README.md 项目说明(技术栈、架构、快速开始、功能规划、文档导航)

Made-with: Cursor
2026-02-27 16:27:07 +08:00

4.4 KiB
Raw Blame History

会议模块 API (Meeting)

通用规范(认证方式、响应格式、错误码)见 README.md 会议中的实时信令Transport/Producer/Consumer通过 WebSocket 完成,见 websocket.md


接口列表

方法 路径 权限 说明
POST /api/v1/meetings 需认证 创建即时会议
POST /api/v1/meetings/schedule 需认证 预约会议
GET /api/v1/meetings/:code 需认证 获取会议信息
POST /api/v1/meetings/:code/join 需认证 加入会议
POST /api/v1/meetings/:code/leave 需认证 离开会议
GET /api/v1/meetings/upcoming 需认证 获取即将开始的会议
GET /api/v1/meetings/ongoing 需认证 获取进行中的会议
GET /api/v1/meetings/history 需认证 获取历史会议

1. 创建即时会议

POST /api/v1/meetings

权限: 需认证

请求参数:

字段 类型 必填 说明
title string 会议标题
password string 会议密码,不设则任何人可加入
max_members int 最大人数,默认 50
settings object 会议设置

settings 可选字段:

字段 类型 默认值 说明
mute_on_join bool false 入会时自动静音
allow_recording bool false 是否允许录制(预留)

成功响应:

{
    "code": 0,
    "message": "ok",
    "data": {
        "id": 1,
        "room_code": "123-456-789",
        "title": "产品需求讨论",
        "type": 1,
        "status": 1,
        "host_id": 1,
        "max_members": 50,
        "created_at": "2026-02-27T10:00:00Z"
    }
}

2. 预约会议

POST /api/v1/meetings/schedule

权限: 需认证

请求参数:

字段 类型 必填 说明
title string 会议标题
scheduled_at string 预约时间ISO 8601如 "2026-03-01T14:00:00Z"
password string 会议密码
max_members int 最大人数
invite_user_ids int[] 预先邀请的用户 ID 列表
settings object 会议设置

说明: 预约会议创建后 status=0未开始被邀请的用户会收到通知。系统在预约时间前 15 分钟和 5 分钟各推送一次提醒。


3. 获取会议信息

GET /api/v1/meetings/:code

权限: 需认证

路径参数: code — 会议号

成功响应:

{
    "code": 0,
    "message": "ok",
    "data": {
        "id": 1,
        "room_code": "123-456-789",
        "title": "产品需求讨论",
        "type": 1,
        "status": 1,
        "host": {
            "id": 1,
            "nickname": "张三",
            "avatar": "https://..."
        },
        "has_password": true,
        "max_members": 50,
        "current_members": 5,
        "started_at": "2026-02-27T10:00:00Z",
        "participants": [
            { "user_id": 1, "nickname": "张三", "role": 1, "joined_at": "2026-02-27T10:00:00Z" },
            { "user_id": 2, "nickname": "李四", "role": 0, "joined_at": "2026-02-27T10:01:00Z" }
        ]
    }
}

4. 加入会议

POST /api/v1/meetings/:code/join

权限: 需认证

请求参数:

字段 类型 必填 说明
password string 会议密码(如果会议设有密码)

成功响应包含加入会议所需的信令参数。

可能的错误码: 4001, 4002, 4003, 4004


5. 离开会议

POST /api/v1/meetings/:code/leave

权限: 需认证

说明: 离开后系统自动计算参会时长。如果主持人离开且没有联合主持人,会议将自动结束。


6. 获取即将开始的会议

GET /api/v1/meetings/upcoming

权限: 需认证

说明: 返回当前用户被邀请的、尚未开始的预约会议列表,按预约时间升序排列。


7. 获取进行中的会议

GET /api/v1/meetings/ongoing

权限: 需认证

说明: 返回当前用户正在参与的或被邀请的进行中会议。


8. 获取历史会议

GET /api/v1/meetings/history

权限: 需认证

查询参数: 支持分页page, page_size

说明: 返回当前用户参与过的已结束会议,按结束时间倒序排列。