一、文档说明

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、聊天室绑定第三方独立域名3、SVG外链和iFrame播放器外链使用说明4、合作网站5、聊天室插件开发使用文档6、从零开始部署一个你自己的BBBUG音乐聊天室

八、下载相关

1、Windows客户端下载

九、部署相关

0、写在最前面1、部署API端步骤说明2、部署Websocket服务端步骤3、部署最后的前端部分Test
1、写在前面
手机阅读

扫描二维码阅读文章

BBBUG,一个开放的音乐聊天室

欢迎你与我们合作,你可以选择下面的方式:

QQ群1140258698

网站接入聊天室

聊天室开放第三方网站的接入,请查阅 https://doc.bbbug.com/2811812.html

聊天室支持了第三方独立域名绑定与系统二级域名绑定,请查阅 https://doc.bbbug.com/2883813.html

聊天室开放了所有的API,你可以自由构建对接一个自己的APP、小程序或网站,具体请查阅下方:

1) 请求方式

  • 本项目API接口除上传文件之外的所有POST请求统一采用JSON进行数据通信,所有数据交互时请严格在JSON相关约束下进行。
  • Content-Type默认使用application/application,上传文件时使用multipart/form-data
  • 项目涉及到的错误代码默认200为成功,其他请参照错误代码表或查看返回的msg字段
  • 项目涉及到的请求参数必须携带plat=*** version=***两个标准公共参数。

2) 注意事项

  • API根路径为 http://api.bbbug.com/api/ ,请求API时追加API地址即可。
  • 图片等附件根路径为 http://api.bbbug.com/uploads/,请求时追加相对路径*******即可。