一、文档说明

1、写在前面2、错误代码表

二、用户接口

1、发送邮箱验证码接口2、用户登录接口3、获取我的个人信息接口4、修改我的资料接口5、临时用户相关说明6、获取指定用户个人资料接口7、禁言用户接口8、禁止用户点歌接口9、取消用户的禁言和禁歌10、摸一摸用户接口11、第三方登录接口

三、房间接口

1、获取热门房间接口2、获取房间详情接口3、获取房间在线人员列表4、修改房间信息接口5、获取指定房间当前正在播放音乐接口6、获取聊天室指定房间的历史记录7、撤回消息接口

四、歌曲接口

1、歌曲搜索接口2、获取LRC歌词接口3、歌曲播放地址跳转地址4、管理员或房主切歌接口5、用户点歌接口6、指定房间当前的已点歌曲列表7、将已点歌曲列表中指定歌曲置顶8、管理或房主移除已点歌曲接口9、获取我点过的歌列表接口10、从我的歌单删除歌曲接口

五、Websocket

1、获取Websocket连接地址2、发送文字消息接口3、发送图片消息接口4、WebSocket消息解析说明文档

六、图片接口

1、搜索图片表情包2、上传图片接口

七、第三方合作接口

1、第三方接入聊天室使用手册与帮助文档2、聊天室绑定第三方独立域名

八、下载相关

1、Windows客户端下载

九、部署相关

0、写在最前面1、部署API端步骤说明2、部署Websocket服务端步骤3、部署最后的前端部分
3、获取房间在线人员列表
手机阅读

扫描二维码阅读文章

本文档由 Tester 自动生成,最后修改时间 2020-09-04 09:23:13

一、接口说明

主动请求在线人员接口

二、请求方式

POST https://api.bbbug.com/api/user/online

三、请求参数

字段 类型 必填 示例 说明
plat string pc -
version number 10000 -
room_id number 888 -

示例JSON:

{
    "plat": "pc",
    "version": 10000,
    "room_id": 888
}

四、更多参数

Headers:

Content-Type:application/json;

五、返回数据

字段 类型 固定 示例值 说明
code number 200 -
msg string success -
data array [] -
data.user_id number 10032 用户ID
data.user_name string Hamm 用户昵称
data.user_head string 头像地址 用户头像地址
data.user_group number 5 用户组1管理5普通用户
data.user_remark string 每个人都应该有签名 签名
data.user_device string Windows 登录设备
data.user_sex number 1 性别1男0女
data.app_id number 1000 所属应用
data.app_name string 浑水摸鱼 应用名称
data.app_url string https://hunshuimoyu.cn 应用地址
data.user_admin boolean false 是否管理
data.user_shutdown boolean false 是否被禁言
data.user_songdown boolean false 是否被禁歌

示例返回结果:

{
    "code": 200,
    "msg": "success",
    "data": [
        {
            "user_id": 10000,
            "user_name": "Hamm",
            "user_head": "659edf8ae2af9743b6f5922bb027872a.png",
            "user_group": 5,
            "user_remark": "欢迎来BBBUG聊天听歌划水呀~",
            "user_device": "MacOS",
            "user_sex": 1,
            "app_id": 1,
            "app_name": "BBBUG",
            "app_url": "https://bbbug.com",
            "user_admin": false,
            "user_shutdown": false,
            "user_songdown": false
        }
    ]
}

六、测试用例

https://tester.hamm.cn/#/20200904/534af9d7a23f6f00f3938bd11fc0d3bb17c8e2bf