一、文档说明

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、部署最后的前端部分
1、第三方接入聊天室使用手册与帮助文档
手机阅读

扫描二维码阅读文章

接入说明

本文旨在让第三方开发者快速将BBBUG聊天室快速接入到自己的网站中,以为自己网站快速提供群聊/音乐/游戏等聊天室功能。

接入方案

我们使用iframe进行BBBUG聊天室地址的嵌入即可完成快速的集成,数据通信与交互采用HTML5的postMessage进行松耦合的方式完成。

用户集成方案

第一步,将自己网站上的用户登录到BBBUG上,如用户未注册,则按OpenID自动注册。
具体请求方式查看Tester上的用例:

https://tester.hamm.cn/#/20200907/8ee5587f6190e1a56cec5d18276cbef0e4b06602

字段 类型 必填 示例
appid string 你的appid
appkey string 你的appkey
openid string 用户在你网站的唯一账号标识
head string 用户的头像URL
nickname string 用户的昵称
extra string 回源URL中#extra#将替换为此字段

第二步,嵌入iframe到你的网站上,嵌入的URL为:

https://bbbug.com/?access_token=ACCESS_TOKEN&room_id=ROOM_ID

其中,ACCESS_TOKEN为第一步获取到的身份凭证,如不提供,则以临时用户进入。ROOM_ID为你想要进入的房间ID,请注意,房间必须为公开房间,如不传,则进入默认888房间。

临时用户说明

如不需要接入自己的用户体系,直接集成上面第二步的URL,不传入access_token即可。

进入自己创建的房间

为了提供更为个性化的服务,我们支持你接入自己创建的房间,进行更好的用户管理,如需要,请集成第二步的URL时,传入指定的room_id即可。

合作案例

  1. 浑水摸鱼 吹牛逼聊天室

更多功能

更多个性化服务正在开发设计中。

联系我

你可以通过QQ:455250574或者Email:admin#hamm.cn(#换成@)联系我们进行合作 :)