一、文档说明

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、部署最后的前端部分
2、获取LRC歌词接口
手机阅读

扫描二维码阅读文章

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

一、接口说明

根据歌曲ID查询歌曲对应的LRC歌词

二、请求方式

POST https://api.bbbug.com/api/song/getLrc

三、请求参数

字段 类型 必填 示例 说明
plat string pc -
version number 10000 -
mid number 148330690 歌曲ID,由websocket下发

示例JSON:

{
    "plat": "pc",
    "version": 10000,
    "mid": 148330690
}

四、更多参数

Headers:

Content-Type:application/json;

五、返回数据

字段 类型 固定 示例值 说明
code number 200 -
msg string -
data array [] -
data.lineLyric string 人为情叹 - 阿悠悠 LRC歌词
data.time string 1.47 LRC歌词开始时间(秒)

示例返回结果:

{
    "code": 200,
    "msg": "",
    "data": [
        {
            "lineLyric": "人为情叹 - 阿悠悠 ",
            "time": "1.47"
        },
        {
            "lineLyric": "我走在城南的关                           ",
            "time": "67.27"
        },
        {
            "lineLyric": "人为情而月下感叹",
            "time": "71.78"
        },
        {
            "lineLyric": "倒不如不曾遇见",
            "time": "75.53"
        },
        {
            "lineLyric": "天各两端",
            "time": "78.03"
        },
        {
            "lineLyric": "我走在城南的关                           ",
            "time": "197.53"
        },
        {
            "lineLyric": "看着远小的帆",
            "time": "199.78"
        },
        {
            "lineLyric": "人为情而月下感叹",
            "time": "201.77"
        },
        {
            "lineLyric": "一圈一圈紧紧捆在 心的左边",
            "time": "239.02"
        }
    ]
}

六、测试用例

https://tester.hamm.cn/#/20200904/82cfecc9ae690d5381739cedf7929e6c3642e1c7