一、文档说明

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、合作网站

八、下载相关

1、Windows客户端下载

九、部署相关

0、写在最前面1、部署API端步骤说明2、部署Websocket服务端步骤3、部署最后的前端部分
5、获取指定房间当前正在播放音乐接口
手机阅读

扫描二维码阅读文章

本文档由 Tester 自动生成,最后修改时间 2020-09-16 10:02:03

一、接口说明

你可以使用这个接口获取指定房间正在播放的音乐

二、请求方式

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

三、请求参数

字段 类型 必填 示例 说明
plat string pc -
version number 10000 -
room_id string 888 房间ID

示例JSON:

{
    "plat": "pc",
    "version": 10000,
    "room_id": "888"
}

四、更多参数

Headers:

Content-Type:application/json;

五、返回数据

字段 类型 固定 示例值 说明
type string playSong 类型
time string 10:00:04 无意义
user object {} 点歌人信息
user.user_id number 10000 -
user.user_song number 505 -
user.user_chat number 2929 -
user.user_img number 352 -
user.user_sex number 1 -
user.user_extra string -
user.user_device string MacOS -
user.user_gamesongscore number 11 -
user.user_name string Hamm -
user.user_head string https://a5fd159ad9dc.PNG -
user.user_remark string 欢迎来BBBUG听歌呀 -
user.app_id number 1 -
user.app_name string BBBUG -
user.app_url string https://bbbug.com -
user.user_admin boolean false -
song object {} 歌曲信息
song.mid number 27866905 -
song.name string Schnappi Das Kleine Krokodil -
song.pic string http://40893.jpg -
song.length number 129 -
song.singer string Schnappi -
at boolean false 送给谁
since number 1600221602 开始播放时间
now number 1600221604 当前时间

示例返回结果:

{
    "type": "playSong",
    "time": "10:00:04",
    "user": {
        "user_id": 10000,
        "user_song": 505,
        "user_chat": 2929,
        "user_img": 352,
        "user_sex": 1,
        "user_extra": "",
        "user_device": "MacOS",
        "user_gamesongscore": 11,
        "user_name": "Hamm",
        "user_head": "https://api.bbbug.com/9dc.PNG",
        "user_remark": "欢迎来BBBUG听歌呀",
        "app_id": 1,
        "app_name": "BBBUG",
        "app_url": "https://bbbug.com",
        "user_admin": false
    },
    "song": {
        "mid": 27866905,
        "name": "Schnappi Das Kleine Krokodil",
        "pic": "http://3440893.jpg",
        "length": 129,
        "singer": "Schnappi"
    },
    "at": false,
    "since": 1600221602,
    "now": 1600221604
}

六、测试用例

https://tester.hamm.cn/#/20200916/215e95d25b6b3646d027ce70f4b2a851281500e7