一、文档说明

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
2、聊天室绑定第三方独立域名
手机阅读

扫描二维码阅读文章

:joy: 温馨提示:新版本已经砍掉了域名相关的功能,如需要请下载老版本,本文档已作废!

一、使用平台提供的二级域名

聊天室已支持自定义二级域名绑定聊天室,请直接在房间管理里填写一个未使用的二级域名即可。

  1. 登录bbbug.com,右上角换房创建自己的房间并进入;
  2. 点击房间左上角的管理,设置一个二级域名地址,如 a.bbbug.com
  3. 你可以通过二级域名访问到你的房间啦。

二、使用独立域名(提供两种方式)

1. 使用http方式的域名直接解析

如需使用独立域名,请提前联系我们配置。否则第三方登录可能无法使用。
联系邮箱:admin#hamm.cn(#换成@)

请注意,直接解析需要你的域名已在阿里云备案,同时: