实战Netty集群 - 分布式聊天实战-WebIm

webim.js

通讯文件

• 分离了API 与webSocket 。
• 群通道，用户通道。
• 重试次数，心跳检测，断网重连。
• 字节传输，支持自定义加密解密等功能。

1.1 用户绑定

• 方法名 login

• 参数说明

属性名	备注	类型	可选值
userId	用户唯一标识	String	5f6d9d98
command	指令集	Number	1
version	版本号	Number	1

• 请求入参

let packet = {
    version:1,
    command: 1,
    userId:"5f6d9d98"
}

• 响应参数

let packet = {
    version : 1,
    command: 2,
    errorMsg:"",
    success: true
}

1.2 加入群组

• 方法名 joinGroup
• 参数说明

属性名	备注	类型	可选值
chatId	聊天对象(群/用户)	String	04b09fbee3d24a21a2acedc755d5d7c3
userId	唯一标识	String	5f6d9d98
chatType	聊天类型(群聊/私聊)	Number	0/1
command	指令集	Number	7
version	版本号	Number	1

• 请求入参

let packet = {
    chatId:"04b09fbee3d24a21a2acedc755d5d7c3",
    userId:"5f6d9d98",
    chatType: 0,
    version: 1,
    command: 7
}

• 响应参数

let packet = {
    version : 1,
    command: 8,
    errorMsg:"",
    success: true
}

1.3 退出群组

• 方法名 quitGroup
• 参数说明(参照加入群组)
• 请求入参

let packet = {
    chatId:"04b09fbee3d24a21a2acedc755d5d7c3",
    userId:"5f6d9d98",
    chatType: 0,
    version: 1,
    command: 9
}

• 响应参数

let packet = {
    version : 1,
    command: 10,
    errorMsg:"",
    success: true
}

1.4 发送消息

• 方法名 sendMessage
• 参数说明

属性名	备注	类型	可选值
isItMe	发送人	Boolen	false/true
contentType	消息类型(文字/图片/语音/视频/红包)	Number	0/1/2/3/4/5
content	消息内容	String	测试
createTime	创建时间	Date	2021-11-2
hasBeenSentId	消息id	String	1447565
fromUserId	发送人id	String	220e805b8521444e9f27d78e45633b44
fromUserName	发送人账户	String	test
fromUserHeadImg	发送人图像	String	defalut.jpg
userId	当前用户id	String	5f6d9d98
toUserId	接收人id	String	5f6d9d98
toUserName	接收人账户	String	admin
toUserHeadImg	接收人图像	String	defalut.jpg
chatType	聊天类型(群/私)	Number	1/0
version	版本	Number	1
command	指令集	Number	3

• 请求入参

let packet = {
    isItMe: true,
    contentType: 0,
    content: "测试",
    createTime: Date.now(),
    hasBeenSentId: Date.now(),
    fromUserId: "5f6d9d98",
    fromUserName: "admin",
    fromUserHeadImg: '/static/image/huge.jpg',
    userId: "5f6d9d98",
    toUserId: "220e805b8521444e9f27d78e45633b44",
    toUserName: "test",
    toUserHeadImg:'/static/image/huge.jpg',
    chatType: 0,
    version : 1,
    command: 3,
};

• 响应参数

let packet = {
    isItMe: true,
    contentType: 0,
    content: "测试",
    createTime: Date.now(),
    hasBeenSentId: Date.now(),
    fromUserId: "5f6d9d98",
    fromUserName: "admin",
    fromUserHeadImg: '/static/image/huge.jpg',
    userId: "5f6d9d98",
    toUserId: "220e805b8521444e9f27d78e45633b44",
    toUserName: "test",
    toUserHeadImg:'/static/image/huge.jpg',
    chatType: 0,
    version : 1,
    command: 4,
};

1.5 指令集参照表

指令集	备注
1	用户绑定请求
2	用户绑定响应
7	加群请求
8	加群响应
9	退群请求
10	退群响应
3	发送消息请求
4	发送消息响应