一、文档说明

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
5、聊天室插件开发使用文档
手机阅读

扫描二维码阅读文章

开发说明

为了更丰富BBBUG音乐聊天室的其他玩法,我们设计了基于iframe嵌入方式的插件开发,你可以使用简单的HTML/CSS/JavaScript进行一个第三方插件的开发

普通插件体验demo: https://bbbug.com/110
全屏插件体验demo: https://bbbug.com/2222

全屏插件为优质插件,如需开发全屏插件,请联系@Hamm(ID:110)

准备工作

  1. 已部署https的静态网站,已创建好的房间;
  2. 查看下面的开放API文档并着手开发。

API接口文档

1. 监听BBBUG开放的部分事件:

window.addEventListener('message', function(event) {
    switch(event.data.event){
        case 'lrc':
            //获取到歌词数据对象事件
            break;
        case 'lrcString':
            //单条歌词变更事件
            break;
        case 'playSong':
            //音乐播放事件
            break;
        case 'sendText':
            //发送文本消息事件
            break;
        case 'touch':
            //摸别人事件
            break;
        case 'addFavSong':
            //添加歌曲收藏事件
            break;
        case 'jump':
            //收到一张飞机票
            break;
        case 'addSong':
            //点歌事件
            break;
        case 'pushSong':
            //顶歌事件
            break;
        case 'removeSong':
            //歌曲移除事件
            break;
        case 'removeban':
            //用户被解禁事件
            break;
        case 'shutdown':
            //用户被禁言事件
            break;
        case 'songdown':
            //用户被禁止点歌事件
            break;
        case 'init':
            //初始化事件 得到用户信息和房间信息
            break;
        case 'sendImg':
            //发送图片事件
            break;
        case 'volumeChanged':
            //音量发生改变
            break;
        case 'themeChanged':
            //主题发生改变
            break;
        case 'messageController':
            //全屏应用接管消息
            break;
        case 'messageList':
            //聊天记录消息列表回调
            break;
        default:
    }
});