138 lines
1.9 KiB
Markdown
138 lines
1.9 KiB
Markdown
# 消息表情回应模块接口文档
|
|
|
|
## 模块概述
|
|
消息表情回应模块提供对私聊消息添加表情符号作为快速回应的功能。
|
|
|
|
---
|
|
|
|
## 接口列表
|
|
|
|
### 1. 添加表情回应
|
|
|
|
**接口路径**: `POST /api/front/messages/reactions/add`
|
|
|
|
**请求头**:
|
|
```
|
|
Authorization: Bearer {token}
|
|
```
|
|
|
|
**请求参数**:
|
|
```json
|
|
{
|
|
"messageId": "消息ID",
|
|
"emoji": "表情符号"
|
|
}
|
|
```
|
|
|
|
**emoji说明**: 支持的表情符号如 👍 ❤️ 😂 😮 😢 😠 🔥 👏 🤔 🎉 ⭐ ✅
|
|
|
|
**返回参数**:
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"msg": "success",
|
|
"data": true
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
### 2. 移除表情回应
|
|
|
|
**接口路径**: `DELETE /api/front/messages/reactions/remove`
|
|
|
|
**请求头**:
|
|
```
|
|
Authorization: Bearer {token}
|
|
```
|
|
|
|
**请求参数**:
|
|
```json
|
|
{
|
|
"messageId": "消息ID",
|
|
"emoji": "表情符号"
|
|
}
|
|
```
|
|
|
|
**返回参数**:
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"msg": "success",
|
|
"data": true
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
### 3. 获取消息的所有表情回应
|
|
|
|
**接口路径**: `GET /api/front/messages/{messageId}/reactions`
|
|
|
|
**请求头**:
|
|
```
|
|
Authorization: Bearer {token}
|
|
```
|
|
|
|
**请求参数**:
|
|
```
|
|
messageId: 消息ID (路径参数)
|
|
```
|
|
|
|
**返回参数**:
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"msg": "success",
|
|
"data": [
|
|
{
|
|
"emoji": "👍",
|
|
"count": 5,
|
|
"reactedByMe": true
|
|
},
|
|
{
|
|
"emoji": "❤️",
|
|
"count": 3,
|
|
"reactedByMe": false
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
**字段说明**:
|
|
- emoji: 表情符号
|
|
- count: 回应数量
|
|
- reactedByMe: 当前用户是否已回应
|
|
|
|
---
|
|
|
|
### 4. 获取特定表情的用户列表
|
|
|
|
**接口路径**: `GET /api/front/messages/{messageId}/reactions/users`
|
|
|
|
**请求头**:
|
|
```
|
|
Authorization: Bearer {token}
|
|
```
|
|
|
|
**请求参数**:
|
|
```
|
|
messageId: 消息ID (路径参数)
|
|
emoji: 表情符号 (查询参数)
|
|
```
|
|
|
|
**返回参数**:
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"msg": "success",
|
|
"data": [
|
|
{
|
|
"userId": 用户ID,
|
|
"username": "用户名",
|
|
"avatarUrl": "头像URL"
|
|
}
|
|
]
|
|
}
|
|
```
|