一、文档说明

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、发送邮箱验证码接口
手机阅读

扫描二维码阅读文章

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

一、接口说明

请注意,验证码有效时间为10分钟,如果用户没收到,提醒用户查看回收站,有可能被ban了。

二、请求方式

POST https://api.bbbug.com/api/sms/email

三、请求参数

字段 类型 必填 示例 说明
plat string pc -
version number 10000 -
email string admin@hamm.cn 用户邮箱

示例JSON:

{
    "plat": "pc",
    "version": 10000,
    "email": "admin@hamm.cn"
}

四、更多参数

Headers:

Content-Type:application/json;

五、返回数据

字段 类型 固定 示例值 说明
code number 500 -
msg string 邮件发送过于频繁,请稍后再试 -

示例返回结果:

{
    "code": 500,
    "msg": "邮件发送过于频繁,请稍后再试"
}

六、测试用例

https://tester.hamm.cn/#/20200904/70db6292e72eea93632f63c3331b73759467a8c8