一、文档说明

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、获取热门房间接口
手机阅读

扫描二维码阅读文章

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

一、接口说明

你可以在这里对接口进行一些简单的描述

二、请求方式

POST https://api.bbbug.com/api/room/hotRooms

三、请求参数

字段 类型 必填 示例 说明
plat string pc -
version number 10000 -
access_token string 123456 身份令牌

示例JSON:

{
    "plat": "pc",
    "access_token": "123456",
    "version": 10000
}

四、更多参数

Headers:

Content-Type:application/json;

五、返回数据

字段 类型 固定 示例值 说明
code number 200 -
msg string 数据获取成功 -
data array [] -
data.room_id number 888 房间ID
data.room_user number 10000 房间所有人
data.room_score number 2 房间积分
data.room_online number 2 在线人数
data.room_name string BBBUG点歌音乐房 房间名称
data.room_type number 1 房间类型,见房间类型说明
data.room_public number 1 1需要密码
data.room_notice string 欢迎来到BBBUG 房间公告
data.room_order number 10000000 房间排序
data.room_addsong number 1 1仅房主可点歌
data.room_sendmsg number 0 1全员禁言0正常
data.room_robot number 0 1打开机器人点歌
data.room_huya string https://www.huya.com/1234 虎牙直播地址
data.room_reason string 违规 封禁原因
data.room_status number 0 状态1封禁
data.user_id number 10000 房间所有人ID
data.user_name string Hamm 所有人昵称
data.user_admin boolean false 所有人是否管理员

示例返回结果:

{
    "code": 200,
    "msg": "数据获取成功",
    "data": [
        {
            "room_id": 888,
            "room_user": 10000,
            "room_online": 2,
            "room_score": 123,
            "room_name": "BBBUG点歌音乐房",
            "room_type": 1,
            "room_public": 0,
            "room_notice": "欢迎来到BBBUG,点歌系统升级完成,欢迎来点歌呀",
            "room_order": 10000000,
            "room_addsong": 1,
            "room_sendmsg": 0,
            "room_robot": 0,
            "room_huya": 'https://huya.com/1234',
            "room_reason": "",
            "room_status": 0,
            "user_id": 10000,
            "user_name": "Hamm",
            "user_admin": false
        },
        {
            "room_id": 6666,
            "room_user": 10007,
            "room_online": 0,
            "room_score": 123,
            "room_name": "听歌猜歌游戏房",
            "room_type": 2,
            "room_public": 0,
            "room_notice": "欢迎来猜歌,请等待上一局游戏结束后参与!",
            "room_order": 800000,
            "room_addsong": 1,
            "room_sendmsg": 0,
            "room_robot": 0,
            "room_huya": 'https://huya.com/1234',
            "room_reason": "",
            "room_status": 0,
            "user_id": 10007,
            "user_name": "猜歌小伙",
            "user_admin": false
        },
        {
            "room_id": 999,
            "room_user": 1,
            "room_online": 0,
            "room_score": 123,
            "room_name": "开发者房间",
            "room_type": 1,
            "room_public": 1,
            "room_notice": "这里是开发者房间,讨论项目开发等事情",
            "room_order": 1001,
            "room_addsong": 1,
            "room_sendmsg": 0,
            "room_robot": 0,
            "room_huya": 'https://huya.com/1234',
            "room_reason": "",
            "room_status": 0,
            "user_id": 1,
            "user_name": "机器人",
            "user_admin": true
        }
    ]
}

六、测试用例

https://tester.hamm.cn/#/20200915/c46fc41ce0a28bd64c884f28b70e547bf989a63f