Appearance
管理后台 API
认证方式
所有管理接口使用 API Key 认证,请求头携带 Authorization: Bearer <api_key>。 API Key 在服务端配置文件中设置。
用户管理
获取所有用户列表
GET /api/admin/users响应示例
json
{
"code": 200,
"data": [
{
"id": "user_001",
"username": "alice",
"avatar": "",
"nickname": "Alice",
"email": "alice@example.com",
"gender": "",
"bio": "",
"phone": "",
"created_at": 1719820800000,
"updated_at": 1719900000000,
"push_enabled": 1,
"dnd_enabled": 0
}
]
}获取用户联系人
GET /api/admin/user/:userId/contacts响应示例
json
{
"code": 200,
"data": {
"users": [
{ "id": "user_002", "username": "bob", "avatar": "" }
],
"groups": [
{ "id": "group_001", "name": "技术交流群" }
]
}
}获取聊天记录
管理员可查看任意两个用户或群聊的完整聊天记录。
GET /api/admin/history查询参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | single(私聊)或 group(群聊) |
| toId | string | 是 | 接收方 ID(群聊为群 ID) |
| fromId | string | 私聊必填 | 发送方 ID(私聊时必须提供) |
响应示例
json
{
"code": 200,
"data": [
{
"id": "msg_001",
"from_id": "user_a",
"to_id": "user_b",
"type": "single",
"content": "你好",
"timestamp": 1719820800000,
"content_type": "text",
"is_revoked": 0
}
]
}群聊管理
获取所有群列表
GET /api/admin/groups响应示例
json
{
"code": 200,
"data": [
{
"id": "group_001",
"name": "技术交流群",
"creator_id": "user_a",
"create_time": 1719820800000,
"announcement": "欢迎加入!"
}
]
}获取群成员列表
GET /api/admin/group/:groupId/members响应示例
json
{
"code": 200,
"data": [
{
"user_id": "user_a",
"role": "creator",
"is_muted": 0,
"username": "小明",
"avatar": "",
"join_time": 1719820800000
}
]
}创建群聊
POST /api/admin/group/create请求体
json
{
"id": "group_002",
"name": "新群聊",
"creatorId": "user_a"
}| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | string | 是 | 群 ID |
| name | string | 是 | 群名称 |
| creatorId | string | 是 | 群主用户 ID |
响应
json
{ "code": 200, "message": "Group created" }更新群信息
POST /api/admin/group/update请求体
json
{
"id": "group_001",
"name": "新群名称"
}| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | string | 是 | 群 ID |
| name | string | 是 | 新群名称 |
响应
json
{ "code": 200, "message": "Group updated" }群不存在时返回 404。
删除群聊
DELETE /api/admin/group/:id响应
json
{ "code": 200, "message": "Group deleted" }添加群成员
POST /api/admin/group/member/add请求体
json
{
"groupId": "group_001",
"userId": "user_c"
}响应
json
{ "code": 200, "message": "Member added" }移除群成员
POST /api/admin/group/member/remove请求体
json
{
"groupId": "group_001",
"userId": "user_c"
}响应
json
{ "code": 200, "message": "Member removed" }认证方式
管理接口不使用 JWT 认证,而是通过预配置的 API Key 进行身份验证。
bash
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://chat.example.com/api/admin/users安全建议
API Key 应在服务端配置中设置,建议使用高强度随机字符串。