聊天接口

一.基本流程

连接 --> 检查连接成功或失败 --> 接收未读消息 --> 开始聊天:发送或接收消息 --> 关闭软件后台，断开连接

二.发送消息

每次发送消息要在Header处携带：

Authorization: {你的token}

发送消息格式如下：

{
    "type" : "single",
    "roomId" : 1,
    "content" : "999"
}

参数解释：

type: 单聊还是群聊，值有两个，single group
roomId: 聊天室Id，唯一标识聊天室
content: 聊天内容

三.接收消息

1.基本格式

{
    "code": 201,
    "msg": "已查询未读数据返回",
    "data": []
}

参数说明：

code:返回状态码
msg:消息说明
data:返回的数据

2.返回状态码

RETURN_UNREAD -- 201 -- 查询未读消息返回
SEND_SECCESS -- 202 -- 发送消息成功
RECEIVED_MESSAGE -- 203 -- 接收消息成功

PARAMETER_ERROR -- 400 --客户端传递参数异常
SERVER_ERROR -- 500 -- 服务端处理异常

说明：正式开始聊天收到对应消息进行Json解析，获取对应的状态码进行相应的操作。
状态码201,202,203属于正常流程
当状态码为201，将未读消息存储到本地，并显示给用户; 当状态码为202，不做处理，或如果像QQ发送中有灰色圆圈，取消灰色圆圈；当状态码为203，将接收的消息存储到本地并返回给用户。
状态码为400和500为异常状态。
这时候跳出提示框打印msg中的内容给用户。

3.常见返回一览

[1]查询未读消息返回

{
    "code": 201,
    "msg": "已查询未读数据返回",
    "data": [
        {
            "id": 1853709262389362689,
            "roomId": 1,
            "sendUserId": 1,
            "content": "999",
            "sendTime": "2024-11-05T16:01:43"
        },
        {
            "id": 1853709265157603330,
            "roomId": 1,
            "sendUserId": 1,
            "content": "999",
            "sendTime": "2024-11-05T16:01:43"
        }
    ]
}

[2]发送消息成功

{
    "code": 202,
    "msg": "消息发送成功",
    "data": null
}

[3]接收消息

{
    "code": 203,
    "msg": "接收消息",
    "data": {
        "id": 1853709494741221378,
        "roomId": 1,
        "sendUserId": 2,
        "content": "666",
        "sendTime": "2024-11-05T16:02:38"
    }
}

[4]消息类型错误

{
    "code": 400,
    "msg": "消息类型错误",
    "data": null
}

[5]服务端处理异常

{
    "code": 500,
    "msg": "没有找到对应的聊天室",
    "data": null
}

一.基本流程#

二.发送消息#

三.接收消息#

1.基本格式#

2.返回状态码#